Create an API

POST {{baseUrl}}/apis?workspaceId=<string>

Creates an API. Include the following properties in the request body:

  • name — A string value that contains the API's name.

You can include the following optional properties:

  • summary — A string value that contains a summary of the API.
  • description — A string value that contains the description of the API.

Request Params

KeyDatatypeRequiredDescription
workspaceIdstring(Required) The workspace ID.

Request Body

{"name"=>"{{apiName}}", "summary"=>"{{apiSummary}}", "description"=>"{{apiDescription}}"}

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: Created

{&quot;createdAt&quot;:&quot;2022-06-29T20:46:58.000Z&quot;,&quot;updatedAt&quot;:&quot;2022-06-29T20:46:58.000Z&quot;,&quot;id&quot;:&quot;5360b75f-447e-467c-9299-12fd6c92450d&quot;,&quot;name&quot;:&quot;Test API&quot;,&quot;summary&quot;:&quot;Test API Schema&quot;,&quot;description&quot;:&quot;This is a test API.&quot;,&quot;createdBy&quot;:&quot;12345678&quot;,&quot;updatedBy&quot;:&quot;12345678&quot;}