Summary
REST Call
Description
Execute a REST call
Route
No Northbound API Available
Roles
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| uri |
string |
yes |
The URI for the REST call |
| verb |
enum |
yes |
Allowed values are: [ DELETE, GET, PATCH, PUT, POST ] - Verb for the REST call |
| user |
string |
no |
User for the API |
| password |
string |
no |
Cleartext password for the API |
| headers |
object |
no |
Any custom headers |
| body |
object |
no |
Body for the API call |
| responseHeaders |
boolean |
yes |
Include response headers? |
Copied to Clipboard
{
"uri": "https://se-demo-1.itential.io/login",
"verb": "POST",
"responseHeaders": false,
"user": "testUser",
"password": "password",
"headers": {
"Content-Type": "application/json"
},
"body": {
"user": {
"username": "user",
"password": "secret"
}
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"uri": {
"title": "uri",
"type": "string",
"examples": [
"https://se-demo-1.itential.io/login"
]
},
"verb": {
"title": "verb",
"type": "string",
"enum": [
"DELETE",
"GET",
"PATCH",
"PUT",
"POST"
]
},
"user": {
"title": "user",
"type": "string",
"examples": [
"testUser"
]
},
"password": {
"title": "password",
"type": "string",
"examples": [
"password"
]
},
"headers": {
"title": "headers",
"type": "object",
"properties": {
"Content-Type": {
"type": "string",
"examples": [
"application/json"
]
}
}
},
"body": {
"title": "body",
"type": "object",
"properties": {
"user": {
"username": {
"type": "string",
"examples": [
"user"
]
},
"password": {
"type": "string",
"examples": [
"secret"
]
}
}
}
},
"responseHeaders": {
"title": "responseHeaders",
"type": "boolean"
}
},
"required": [
"uri",
"verb",
"responseHeaders"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
object |
response from the REST call |
Copied to Clipboard
{
"response": "ZDA3MWFmMGUwZmRlOGVkOTVmN2E5OTI2MzdmYzgxNmI="
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"response": {
"type": "string",
"examples": [
"ZDA3MWFmMGUwZmRlOGVkOTVmN2E5OTI2MzdmYzgxNmI="
]
}
}
}
