The API Call object defines the HTTP request that we make from a Deployment. The request can have an Authentication Setting and Authentication Token applied to it.
Example object:
JSON
{
"meta": {
"domain": "httpbin.org",
"description": null,
"created": "2015-09-18T23:29:39.534120Z",
"tags": [],
"accept": null,
"last_update": "2015-09-18T23:29:39.534173Z",
"content_type": null,
"owner": "agxkZXZ-dmlhdGVzdHNyEQsSBFVzZXIYgICAgICAgAoM",
"name": "Minimal API test name"
},
"request": {
"body": null,
"parameters": [],
"url": "http://httpbin.org/get",
"auth_id": null,
"headers": [],
"token_id": null,
"method": "GET"
},
}
Name Description Required? meta See below Y access See below N request See below Y
Name Description Required? name Name of call for your reference Yes description Description of call for your reference No tags List of tags for the call for your reference No owner ID of owner of Call No - readonly
Name Description Required? method HTTP method to use Y url URL to call Y parameters List of request parameters to append to call N headers List of headers to include in call N body Content of POST or PUT call N auth_id ID of authentication settings to use N token_id ID of token to use with authentication settings N