Number of APIs: 6
1. Get all APIs
GET {{baseUrl}}/apis?workspaceId=<string>
Gets information about all APIs in a workspace. Note: This endpoint only returns APIs created or migrated in Qodex v10 and higher.
2. Get an API
GET {{baseUrl}}/apis/{{apiId}}
Gets information about an API. Note:
versions
and gitInfo
query responses. This is because schema and collection information is stored in the connected Git repository. The gitInfo
object only lists the repository and folder locations of the files.versions
option in the include
query parameter.
DELETE {{baseUrl}}/apis/{{apiId}}
Deletes an API.
4. Get status of an asynchronous task
GET {{baseUrl}}/apis/{{apiId}}/tasks/{{taskId}}
Gets the status of an asynchronous task.
PUT {{baseUrl}}/apis/{{apiId}}
Updates an API. Include at least one of the following properties in the request body:
name
— A string value that contains the API's name.summary
— A string value that contains a summary of the API.description
— A string value that contains the description of the API. This supports Markdown formatting.
POST {{baseUrl}}/apis?workspaceId=<string>
Creates an API. Include the following properties in the request body: You can include the following optional properties:
name
— A string value that contains the API's name.
summary
— A string value that contains a summary of the API.description
— A string value that contains the description of the API.
ENDPOINTS