Skip to navigation

Update HTTP connector

View as Markdown

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, null clears it, and nested objects merge field by field. Lists of objects merge row by row instead of being replaced, so read the document first and send the whole list back when you reorder or remove rows. Lists of strings, Data Mapper expressions, JSON schemas, workflow_steps and resolver_methods are replaced whole. The id goes in the URL; if you also send id in the body it must match.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Path parameters

idstringRequired

The id of the HTTP connector, as returned when it was created or listed.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
base_urlstringOptional>=1 character

Base URL of the external API that every action path is appended to, for example https://api.example.com/v1. Must use https and a publicly reachable host unless the connector is routed through an on-premise agent.

basic_authobjectOptional
HTTP basic authentication with a username and password.
api_key_authobjectOptional
API key authentication, sent in a header or query parameter.
oauth2objectOptional
OAuth 2.0 authentication.
jwt_authobjectOptional
JWT bearer authentication signed with a private key you provide.
jwks_authobjectOptional
JWT bearer authentication signed with a key pair that Moveworks generates and rotates.
no_authobjectOptional
No authentication. Set to an empty object to send requests without credentials.
headerslist of objectsOptional
Headers added to every request made through this connector.
query_paramslist of objectsOptional
Query parameters added to every request made through this connector.
x509_optionsobjectOptional
Client certificate and private key for mutual TLS. Used only when both are set.
csrf_token_optionsobjectOptional
Settings for fetching a CSRF token before requests, for systems that require one.

Response

The updated HTTP connector, at its new version
idstringOptionalRead-only
Unique identifier of the HTTP connector, assigned by the server.
namestringOptionalformat: "^[a-zA-Z][a-zA-Z0-9_]+$"2-64 characters

Unique name of the connector, used by HTTP actions to refer to it. 2-64 letters, digits or underscores, starting with a letter. Cannot be changed, or reused after deletion.

display_namestringOptionalRead-only

Label shown for the connector in Tool Studio. Read-only; defaults to the name.

descriptionstringOptionalRead-only

Description of the connector as shown in Tool Studio. Read-only.

base_urlstringOptional>=1 character

Base URL of the external API that every action path is appended to, for example https://api.example.com/v1. Must use https and a publicly reachable host unless the connector is routed through an on-premise agent.

basic_authobjectOptional
HTTP basic authentication with a username and password.
api_key_authobjectOptional
API key authentication, sent in a header or query parameter.
oauth2objectOptional
OAuth 2.0 authentication.
jwt_authobjectOptional
JWT bearer authentication signed with a private key you provide.
jwks_authobjectOptional
JWT bearer authentication signed with a key pair that Moveworks generates and rotates.
no_authobjectOptional
No authentication. Set to an empty object to send requests without credentials.
headerslist of objectsOptional
Headers added to every request made through this connector.
query_paramslist of objectsOptional
Query parameters added to every request made through this connector.
x509_optionsobjectOptional
Client certificate and private key for mutual TLS. Used only when both are set.
csrf_token_optionsobjectOptional
Settings for fetching a CSRF token before requests, for systems that require one.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error