Skip to main content

Create: HTTP Request type

Description#

Use a HTTP POST request to create a HTTP Request credential.

Request#

HTTP Method: POST

ParameterDescription
nameName of the credential.
modeDescribes the type of credential (HTTP_REQUEST_AGENT)
team_idID of Tines Team where the credential will be located.
folder_idOptional ID of folder to which the credential will be located
read_accessOptional Control where this credential can be used (TEAM, GLOBAL). default: TEAM
http_request_optionsJSON object representing the Agents::HTTPRequestAgent Options
http_request_location_of_tokenLocation of token from response

Sample request#

curl -X POST \  https://<tenant-domain>/api/v1/user_credentials \  -H 'content-type: application/json' \  -H 'x-user-email: <email-address>' \  -H 'x-user-token: <api-token>' \  -d '{      "name": "foo",      "value": "bar",      "mode": "HTTP_REQUEST_AGENT",      "team_id": 2,      "http_request_options": {        "url": "http://www.example.com",        "content_type": "json",        "method": "post",        "payload": {          "key": "value",          "something": "the event contained {{ .somekey }}"        },        "headers": {}      },      "http_request_location_of_token": "{{ .foo }}"    }'

Response#

A successful request will return a JSON object describing the created credential.

Field description#

ParameterDescription
idcredential ID.
nameName of the credential.
modeDescribes the type of credential (TEXT, JWT, OAUTH, AWS, MTLS, HTTP_REQUEST_AGENT)
team_idID of team to which the credential belongs.
folder_idID of folder to which the credential belongs.
read_accessControl where this credential can be used.
slugAn underscored representation of the credential name
created_atISO 8601 Timestamp representing date and time the credential was created.
updated_atISO 8601 Timestamp representing date and time the credential was last updated.

Sample response#

{  "id": 1,  "name": "tines_api_credential",  "mode": "HTTP_REQUEST_AGENT",  "team_id": 2,  "folder_id": 1,  "created_at": "2021-03-26T12:34:16.540Z",  "updated_at": "2021-03-26T12:34:16.540Z"}