Qodex.ai

Postman API

Number of APIs: 170

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

Important

  • You must pass an Accept header with the application/vnd.api.v10+json value to use v10 and higher endpoints. While some of these endpoints may appear the same as the deprecated Qodex v9 endpoints, they will use the v10 behavior when you send this Accept header. For more information, see [About v9 and v10 APIs]
  • To use the API endpoints, you must first [update your APIs to the v10 format]

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.

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.
  • 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.

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.

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]

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 an environment variable. The Qodex API collection will use it to make API calls.

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. Also, depending on your [plan] you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.

Each API response returns the following set of headers to help you identify your use status:

HeaderDescription
X-RateLimit-LimitThe maximum number of requests that the consumer is permitted to make per minute.
X-RateLimit-RemainingThe number of requests remaining in the current rate limit window.
X-RateLimit-ResetThe time at which the current rate limit window resets in UTC epoch seconds.

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-v10-Schema - Get schema file contents GET {{baseUrl}}/apis/{{apiId}}/schemas/{{schemaId}}/files/{{filePath}}

  2. API-v10 - Get all APIs GET {{baseUrl}}/apis?workspaceId=<string>

  3. API-v9-Relations - Get integration test relations GET https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/integrationtest

  4. Environments - Get all environments GET {{baseUrl}}/environments

  5. API-v9 - Get all APIs GET https://api.getpostman.com/apis

  6. Audit Logs - Get team audit logs GET {{baseUrl}}/audit/logs

  7. Collections-Items-Requests - Get a request GET {{baseUrl}}/collections/{{collectionId}}/requests/{{requestId}}

  8. Collections-Comments - Delete a collection's comment DELETE {{baseUrl}}/collections/{{collectionUid}}/comments/{{commentId}}

  9. Collections - Get a collection GET {{baseUrl}}/collections/{{collectionId}}

  10. Monitors - Get all monitors GET {{baseUrl}}/monitors