POST /apis

This call creates a new API with a default API Version.

Request body should contain an api object which should atleast have a property name.

Response contains an api object with all the details related to the created API, namely, id, name, summary, description, etc.

Requires API Key as X-Api-Key request header or apikey URL query parameter.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
workspace String No

Request body fields

Name Type Required Description
api Object No
api.name String No
api.description String No
api.summary String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.