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
Key | Datatype | Required | Description |
---|---|---|---|
workspaceId | string | (Required) The workspace ID. |
Request Body
{"name"=>"{{apiName}}", "summary"=>"{{apiSummary}}", "description"=>"{{apiDescription}}"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: Created
{"createdAt":"2022-06-29T20:46:58.000Z","updatedAt":"2022-06-29T20:46:58.000Z","id":"5360b75f-447e-467c-9299-12fd6c92450d","name":"Test API","summary":"Test API Schema","description":"This is a test API.","createdBy":"12345678","updatedBy":"12345678"}