Summary
Send an HTTP/1.1 request to an inventory device.
Description
This method will 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 |
A Host from the HTTP_Requests Inventory |
| endpoint |
string |
yes |
The api endpoint to send the request to. |
| method |
string |
yes |
Request method - one of GET, OPTIONS, HEAD, POST, PUT, PATCH, DELETE |
| params |
object |
no |
Keys/values to convert into the request's query string. |
| data |
object |
no |
Keys/values to send as the request's body. |
| headers |
object |
no |
Keys/values to send as the request's HTTP headers. |
| cookies |
object |
no |
Keys/values to send as the request's cookies. |
| auth |
object |
no |
Keys/values to send as the username and password for Basic Authentication. |
| timeout |
object |
no |
The connect and read timeouts for the request. See: https://docs.python-requests.org/en/latest/user/advanced/#timeouts |
| allowRedirects |
boolean |
no |
A flag which enables or disables HTTP redirection. |
| proxies |
object |
no |
The keys/values which describe proxies to use for the request. |
| verify |
boolean |
no |
A flag which enables or disables TLS certificate verification. |
Copied to Clipboard
{
"host": "xr9kv-atl",
"endpoint": "/api/v2.0/todos",
"method": "GET",
"params": {
"id": 1
},
"headers": {
"content-type": "application/json"
},
"auth": {
"username": "username",
"password": "password"
},
"timeout": {
"connect": "3.05",
"read": "27"
},
"allowRedirects": true,
"proxies": {
"http": "http://10.0.0.1:8080",
"https": "http://10.0.0.1:4343"
},
"verify": true
}
Copied to Clipboard
{
"type": "object",
"properties": {
"host": {
"title": "host",
"type": "string",
"$ref": "deviceData#/definitions/deviceName"
},
"endpoint": {
"title": "endpoint",
"type": "string",
"examples": [
"/api/v2.0/todos"
]
},
"method": {
"title": "method",
"type": "string",
"enum": [
"get",
"GET",
"options",
"OPTIONS",
"head",
"HEAD",
"post",
"POST",
"put",
"PUT",
"patch",
"PATCH",
"delete",
"DELETE"
],
"examples": [
"GET"
]
},
"params": {
"title": "params",
"type": "object",
"properties": {},
"examples": [
{
"id": 1
}
]
},
"data": {
"title": "data",
"type": "object",
"properties": {}
},
"headers": {
"title": "headers",
"type": "object",
"properties": {},
"examples": [
{
"content-type": "application/json"
}
]
},
"cookies": {
"title": "cookies",
"type": "object",
"properties": {}
},
"auth": {
"title": "auth",
"type": "object",
"properties": {
"username": {
"type": "string",
"examples": [
"username"
]
},
"password": {
"type": "string",
"examples": [
"password"
]
}
},
"examples": [
{
"username": "username",
"password": "password"
}
],
"required": [
"username",
"password"
]
},
"timeout": {
"title": "timeout",
"type": "object",
"properties": {
"connect": {
"type": "string",
"examples": [
"3.05"
]
},
"read": {
"type": "string",
"examples": [
"27"
]
}
},
"examples": [
{
"connect": "3.05",
"read": "27"
}
],
"required": [
"connect",
"read"
]
},
"allowRedirects": {
"title": "allowRedirects",
"type": "boolean",
"examples": [
true
]
},
"proxies": {
"title": "proxies",
"type": "object",
"properties": {},
"examples": [
{
"http": "http://10.0.0.1:8080",
"https": "http://10.0.0.1:4343"
}
]
},
"verify": {
"title": "verify",
"type": "boolean",
"examples": [
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
{
"key": "result",
"response": {
"API": "AdoptAPet",
"Auth": "apiKey",
"Category": "Animals",
"Cors": "yes",
"Description": "Resource to help get pets adopted",
"HTTPS": true
},
"status": "200"
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"key": {
"title": "key",
"type": "string",
"examples": [
"result"
]
},
"response": {
"title": "response",
"type": "object",
"examples": [
{
"API": "AdoptAPet",
"Auth": "apiKey",
"Category": "Animals",
"Cors": "yes",
"Description": "Resource to help get pets adopted",
"HTTPS": true
}
]
},
"status": {
"title": "status",
"type": "string",
"examples": [
"200"
]
}
},
"examples": [
{
"key": "result",
"response": {
"API": "AdoptAPet",
"Auth": "apiKey",
"Category": "Animals",
"Cors": "yes",
"Description": "Resource to help get pets adopted",
"HTTPS": true
},
"status": "200"
}
],
"required": [
"key",
"response",
"status"
]
}
