Custom API Action

Make a custom, authenticated HTTP call to the Advanced Server Access API.

This action card enables you to invoke arbitrary API calls against the Advanced Server Access API. Use this card primarily to build flows for operations where none of the pre-built action cards support your use case. Use this connector in lieu of native Workflows API connector as it uses the ASAv2 Connection object that is used by other action cards.

The Custom API Action card automatically builds the URL to the Advanced Server Access API using supplied credentials. The Relative URL field should only contain the path to the endpoint/resource to which you want to send the request. No / is required in front of the value for the relative URL.

The Custom API action does not perform any logical validation for operations (for example, it doesn't prevent a DELETE request from containing an HTTP body). Be sure to review the Advanced Server Access API documentation to ensure that you are calling the API correctly.

Options

Field Definition Type Required
Request Type These are supported HTTP request methods, or HTTP verbs, in a custom API call (see HTTP request methods).
  • GET: Retrieves data from a web server based on parameters. This method requests a representation of the specified resource. If a request is successful, a 200 (OK) response message is returned with the requested content.
  • POST: Sends data to a web server based on parameters (for example, uploading a file). Multiple POST requests may result in a different outcome than a single POST. Caution should be exercised to avoid sending multiple POST requests unintentionally. If a request is successful, a 200 (OK) response message is returned.
  • PUT: Sends data to be stored at a specific location on a web server based on parameters (for example, uploading a file). Unlike POST requests, PUT requests are idempotent. For successful requests, the result of a single PUT request is the same as many identical PUT requests. If a request is successful, a 200 (OK), 201 (Created), or 204 (No Content) response message is returned.
  • DELETE: Deletes the specified resource (if it exists) from the web server based on parameters. If a DELETE is successful, a 200 (OK) response message is returned.
Dropdown TRUE

Input

Field Definition Type Required
Request
Relative URL

URL address on the web server to which you are attempting to interact. Specify the relative URL as /{insert_remaining_URL}. You can specify query parameters in the relative URL using "?", or specify the query parameters as an object key pair in the Query input.

This field is relative to the full URL https://app.scaleft.com/v1/:teams/:teamname

String TRUE
Query Specify any additional query parameters that should be included in object format (key value pairs). Object FALSE
Headers Specify any headers required in addition to authorization or content-type (these are already handled by this connector). Object FALSE
Body Specify a request body in JSON format. Only available for POST and PUT requests. Object FALSE

Output

Field Definition Type
Response
Status Code

Result of the operation. The connector returns an HTTP status code that indicates whether the action taken by the card succeeded or failed. For example:

  • A 201 Created status code indicates success where a new resource was created.
  • A 403 Forbidden error indicates that the HTTP request wasn't processed because the necessary permissions were missing.

For a full list of possible status codes, see HTTP status codes.

 Number
Headers Detailed context for the status code, unrelated to the output body. Response headers are dependent on your selected HTTP request option. Object
Body

The data returned from your selected HTTP request.

For example, the data from a GET request.

 Object

Related topics

Advanced Server Access connector

Workflow elements

Advanced Server Access API documentation