Qodex.ai

Postman API

Number of APIs: 180

Version: 1.15.0

The Qodex API enables you to programmatically access data stored in your Qodex account.

Certain endpoints may be unavailable depending on your region and/or Qodex plan.

Getting started

You can get started with the Qodex API by [forking the Qodex API collection] to your workspace. You can then use Qodex to send requests.

EU users

For users in the EU with [Enterprise plans] the Qodex API uses the subdomain. Included in this collection is an **euUrl** variable that contains the EU-specific subdomain. To use it, update the **baseUrl** value with the subdomain.

About the Qodex API

  • You must use a valid API Key to send requests to the API endpoints.

  • The API has [rate and usage limits]

  • The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.

  • The API returns requests responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.

  • The request method (verb) determines the nature of action you intend to perform. A request made using the GET method implies that you want to fetch something from Qodex. The POST method implies you want to save something new to Qodex.

  • For all requests, API calls respond with their corresponding HTTP status codes. In the Qodex client, the status code also provides help text that details the possible meaning of the response code.

  • When calling the API Builder endpoints, you must pass an Accept header with the application/vnd.api.v10+json value.

IDs and UIDs

All items in Qodex, such as collections, workspaces, and APIs, have IDs and UIDs:

  • An ID is the unique ID assigned to a Qodex item. For example, ec29121c-5203-409f-9e84-e83ffc10f226.

  • The UID is the full ID of a Qodex item. This value is the item's unique ID concatenated with the user ID. For example, in the 12345678-ec29121c-5203-409f-9e84-e83ffc10f226 UID:

    • 12345678 is the user's ID.
    • ec29121c-5203-409f-9e84-e83ffc10f226 is the item's ID.

Enum values

Any documented enum values should be considered partial lists and may change over time.

503 response

An HTTP 503 Service Unavailable response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP 5XX error, [contact support]

403 response for unavailable features

Depending on your region and/or Qodex [plan] some endpoints will return an HTTP 403 Forbidden response with the This feature isn't available in your region. detail.

Authentication

Qodex uses API keys for authentication. The API key tells the API server that the request came from you. Everything that you have access to in Qodex is accessible with your API key. You can [generate] a Qodex API key in the API keys section of your Qodex account settings.

You must include an API key in each request to the Qodex API with the X-API-Key request header. In Qodex, you can store your API key as a [vault secret] or an environment variable. The Qodex API collection will use it to make API calls.

SCIM authentication

While all other endpoints in this collection require a Qodex API key, the SCIM endpoints require a [SCIM API key]

Authentication error response

If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

Rate and usage limits

API access [rate limits] apply at a per-user basis in unit time. The limit is 300 requests per minute. Qodex Monitors have a rate limit of 10 calls in 10 seconds. Depending on your [plan] you may also have [usage limits]

When you reach your rate or usage limits, the API returns the following HTTP 429 Too Many Requests status code with one of the following error responses:

  • rateLimited — Rate limits reached. The response returns the time after which you can resume calls to the Qodex API.

  • serviceLimitExhausted — Qodex API service limits reached. You will need to contact your Qodex Team Admin for assistance.

Support

For help regarding accessing the Qodex API, you can:

  • Visit [Qodex Support] or our [Community and Support] sites.

  • Reach out to the [Qodex community]

  • Submit a help request to [Qodex support]

Policies

  • [Qodex Terms of Service]

  • [Qodex Privacy Policy]

  1. API-API Version - Get all versions GET {{baseUrl}}/apis/{{apiId}}/versions

  2. API-Collections - Add a collection POST {{baseUrl}}/apis/{{apiId}}/collections

  3. Collections-Roles - Get a collection's roles GET {{baseUrl}}/collections/{{collectionId}}/roles

  4. Mocks-Call Logs - Get a mock server's call logs GET {{baseUrl}}/mocks/{{mockId}}/call-logs

  5. API-Schema - Create a schema POST {{baseUrl}}/apis/{{apiId}}/schemas

  6. API-Schema - Create or update a schema file PUT {{baseUrl}}/apis/{{apiId}}/schemas/{{schemaId}}/files/{{filePath}}

  7. API-Schema - Get a schema GET {{baseUrl}}/apis/{{apiId}}/schemas/{{schemaId}}

  8. API-Schema - Get schema files GET {{baseUrl}}/apis/{{apiId}}/schemas/{{schemaId}}/files

  9. API-Schema - Get schema file contents GET {{baseUrl}}/apis/{{apiId}}/schemas/{{schemaId}}/files/{{filePath}}

  10. API-Schema - Delete a schema file DELETE {{baseUrl}}/apis/{{apiId}}/schemas/{{schemaId}}/files/{{filePath}}