Summary
Send an HTTP/1.1 request to an inventory device.
Description
Send an HTTP/1.1 request to an inventory device.
Route
POST /automationgateway/http_requests/request/execute
Roles
admin
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
host |
string |
yes |
- |
endpoint |
string |
yes |
- |
method |
string |
yes |
- |
params |
object |
no |
- |
data |
object |
no |
- |
headers |
object |
no |
- |
cookies |
object |
no |
- |
auth |
object |
no |
- |
timeout |
object |
no |
- |
allowRedirects |
boolean |
no |
- |
proxies |
object |
no |
- |
verify |
boolean |
no |
- |
Copied to Clipboard
{
"host": "fugiat quis incididunt mollit",
"endpoint": "qui eiusmod aute dolore irure",
"method": "PUT",
"auth": {
"username": "veniam sint nostrud",
"password": "reprehenderit"
},
"timeout": {
"connect": "ex elit",
"read": "cillum dolore enim"
},
"allowRedirects": true,
"verify": false
}
Copied to Clipboard
{
"type": "object",
"properties": {
"host": {
"title": "host",
"type": "string",
"example": "ios"
},
"endpoint": {
"title": "endpoint",
"type": "string",
"example": "/api/v2.0/todos"
},
"method": {
"title": "method",
"type": "string",
"enum": [
"get",
"GET",
"options",
"OPTIONS",
"head",
"HEAD",
"post",
"POST",
"put",
"PUT",
"patch",
"PATCH",
"delete",
"DELETE"
],
"example": "GET"
},
"params": {
"title": "params",
"type": "object",
"properties": {}
},
"data": {
"title": "data",
"type": "object",
"properties": {}
},
"headers": {
"title": "headers",
"type": "object",
"properties": {}
},
"cookies": {
"title": "cookies",
"type": "object",
"properties": {}
},
"auth": {
"title": "auth",
"type": "object",
"properties": {
"username": {
"type": "string",
"example": "username"
},
"password": {
"type": "string",
"example": "password"
}
},
"required": [
"username",
"password"
]
},
"timeout": {
"title": "timeout",
"type": "object",
"properties": {
"connect": {
"type": "string",
"example": "3.05"
},
"read": {
"type": "string",
"example": "27"
}
},
"required": [
"username",
"password"
]
},
"allowRedirects": {
"title": "allowRedirects",
"type": "boolean",
"example": "True"
},
"proxies": {
"title": "proxies",
"type": "object",
"properties": {}
},
"verify": {
"title": "verify",
"type": "boolean",
"example": true
}
},
"required": [
"host",
"endpoint",
"method"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
result |
object |
A JSON Object containing status, code and the result |
Copied to Clipboard
{
"title": "result",
"type": "object"
}