30-day challenge API Documentation

Postman API

Number of APIs: 90

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

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.

Overview

You must use a valid API Key to send requests to the API endpoints. You can get your API key from Qodex's integrations dashboard.
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.
You can access individual resources in your Qodex with its unique ID (uid) value. The uid is a simple concatenation of the resource owner's user ID and the resource's ID. For example, a collection's uid is the {{owner_id}}-{{collection_id}} value.

ID and UID

All items in Qodex, such as collections, workspaces, and APIs, have ID 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 user ID concatenated with the item's unique 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.

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.

Using the API key as a query parameter

Requests that accept the X-Api-Key request header also accept the API key when you send it as the apikey query parameter. An API key sent as part of the header has a higher priority when you send the key as both a request header and a query parameter.

Rate and usage limits

API access rate limits apply at a per-API key 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:

Header	Description
`X-RateLimit-Limit`	The maximum number of requests that the consumer is permitted to make per minute.
`X-RateLimit-Remaining`	The number of requests remaining in the current rate limit window.
`X-RateLimit-Reset`	The time at which the current rate limit window resets in UTC epoch seconds.

503 response

An HTTP 503 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]

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. Collections - Create a collection

POST https://api.getpostman.com/collections

Creates a collection using the [Qodex Collection v2 schema format] Include a collection object in the request body that contains the following required properties:

info — An object that contains the following properties:
- name — A string value that contains the collection's name.
- schema — A string that contains a URL to the collection's schema. For example, the https://schema.getQodex.com/collection/v1 URL.
item — An object that contains the HTTP request and response information.
- request — An object that contains the collection's request information. For a complete list of values, refer to the definitions.request entry in the [collection.json schema file] If you pass an empty object for this value, the system defaults to an untitled GET request.

Note:

For a complete list of available property values for this endpoint, use the following references available in the [collection.json schema file]
- info object — Use the definitions.info entry.
- item object — Use the definitions.items entry.
For all other possible values, refer to the [collection.json schema file]

2. Collections - Create a fork

POST https://api.getpostman.com/collections/fork/{{collectionId}}?workspace={{workspaceId}}

Creates a [fork] from an existing collection into a workspace. Include the following required request body properties:

label — The fork's label.

3. Collections - Get a collection

GET https://api.getpostman.com/collections/{{collectionId}}

Gets information about a collection. For a complete list of this endpoint's possible values, use the [collection.json schema file]

4. Collections - Delete a collection

DELETE https://api.getpostman.com/collections/{{collectionId}}

Deletes a collection.

5. Collections - Update a collection

PUT https://api.getpostman.com/collections/{{collectionId}}

Updates a collection using the [Qodex Collection v2 schema format] Include a collection object in the request body that contains the following required properties:

info — An object that contains the following properties:
- name — A string value that contains the collection's name.
- schema — A string that contains a URL to the collection's schema. For example, the https://schema.getQodex.com/collection/v1 URL.
item — An object that contains the HTTP request and response information.
- request — An object that contains the collection's request information. For a complete list of values, refer to the definitions.request entry in the [collection.json schema file] If you pass an empty object for this value, the system defaults to an untitled GET request.

Note:

For a complete list of available property values for this endpoint, use the following references available in the [collection.json schema file]
- info object — Use the definitions.info entry.
- item object — Use the definitions.items entry.
For all other possible values, refer to the [collection.json schema file]

Important

Use caution when using this endpoint. The system will replace the existing collection with the values passed in the request body.

6. Collections - Merge a fork

POST https://api.getpostman.com/collections/merge

Merges a forked collection back into its destination collection. Include the following required properties in the request body:

source — The forked collection's ID.
destination — The destination collection's ID.

You can also include the following optional properties in the request body:

strategy — The fork's merge strategy. One of:
- deleteSource — The system deletes the forked collection after a successful merge into the destination collection.
- updateSourceWithDestination — Default. The system only merges the forked collection into the destination collection.

7. Collections - Get all collections

GET https://api.getpostman.com/collections

Gets all of your collections. The response includes all of your subscribed collections.

8. Environments - Get an environment

GET https://api.getpostman.com/environments/{{environmentId}}

Gets information about an environment.

9. Environments - Delete an environment

DELETE https://api.getpostman.com/environments/{{environmentId}}

Deletes an environment.

10. Environments - Create an environment

POST https://api.getpostman.com/environments

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

name — A string that contains the environment's name.

You can also include the following properties:

values — An array of objects that contains the following:
- key — The variable's name.
- value — The variable's value.
- enabled — If true, enable the variable.
- type — The variable's type. One of: secret, default, or any.

11. Environments - Update an environment

PUT https://api.getpostman.com/environments/{{environmentId}}

Updates an environment. Include the following properties in the request body:

name — A string that contains the environment's name.

You can also include the following optional properties:

values — An array of objects that contains the following:
- key — The variable's name.
- value — The variable's value.
- enabled — If true, enable the variable.
- type — The variable's type. One of: secret, default, or any.

12. Environments - Get all environments

GET https://api.getpostman.com/environments

Gets information about all of your [environments]

13. Mocks - Update a server response

PUT https://api.getpostman.com/mocks/{{mockId}}/server-responses/{{serverResponseId}}

Updates a mock server's server stub. Include at least one of the following properties in the request body:

name — A string that contains the server response's name.
statusCode — A string that contains the server stub's response code. This property only accepts 5xx values.
headers — An array of objects that contains the server stub's headers:
- key — A string that contains the header's key.
- value — A string that contains the header key's value. This value defines the corresponding value for the header key.
body — A string that contains a response body that returns when you call the mock server.

14. Mocks - Get a mock server

GET https://api.getpostman.com/mocks/{{mockId}}

Gets information about a mock server.

15. Mocks - Get a server response

GET https://api.getpostman.com/mocks/{{mockId}}/server-responses/{{serverResponseId}}

Gets information about a mock server's server stub.

16. Mocks - Create a mock server

POST https://api.getpostman.com/mocks

In Qodex v10 and higher you cannot create mocks for collections added to an API definition.

Creates a mock server in a collection. Include a mock object in the request body that contains following properties:

collection — A string that contains the collection ID.

You can include the following optional properties in the request body:

environment — A string that contains the environment ID to associate with the mock server.
name — A string that contains the the mock server's name.

17. Mocks - Get all mock servers

GET https://api.getpostman.com/mocks

Gets all mock servers.

18. Mocks - Delete a mock server

DELETE https://api.getpostman.com/mocks/{{mockId}}

Deletes a mock server.

19. Mocks - Unpublish a mock server

DELETE https://api.getpostman.com/mocks/{{mockId}}/unpublish

Unpublishes a mock server. Unpublishing a mock server sets its Access Control configuration setting to private.

20. Mocks - Get all server responses

GET https://api.getpostman.com/mocks/{{mockId}}/server-responses

Gets all of a mock server's server responses.

21. Mocks - Create a server response

POST https://api.getpostman.com/mocks/{{mockId}}/server-responses

Creates a server response. Server responses let you simulate 5xx server-level responses, such as 500 or 503.

Server-level responses are agnostic to application-level logic. Server responses let you simulate this behavior on a mock server. You do not need to define each error for all exposed paths on the mock server.

If you set a server response as active, then all the calls to the mock server return with that active server response.

Note:

You can create multiple server responses for a mock server, but only one mock server can be set as active.

You must include the following properties in the request body:

* name — A string that contains the server response's name. * statusCode — An integer that contains the server stub's 5xx response code. This property only accepts 5xx values.

You can also include the following optional properties:

* headers — An array of objects that contains the server stub's headers: * key — A string that contains the header's key. * value — A string that contains the header key's value. This value defines the corresponding value for the header key. * body — A string that contains a response body that returns when you call the mock server.

22. Mocks - Delete a server response

DELETE https://api.getpostman.com/mocks/{{mockId}}/server-responses/{{serverResponseId}}

Deletes a mock server's server response.

23. Mocks - Publish a mock server

POST https://api.getpostman.com/mocks/{{mockId}}/publish

Publishes a mock server. Publishing a mock server sets its Access Control configuration setting to public.

24. Mocks - Update a mock server

PUT https://api.getpostman.com/mocks/{{mockId}}

Updates a mock server. Include the mock object in the request body with one or more of the following properties:

name — A string that contains the mock server's name.
environment — A string that contains the environment UID.
private — A boolean value that, if true, sets the mock server as private.
versionTag — A string that contains the API's version tag ID.
config — An object that contains the following properties:
- serverResponseId — A string that contains the server response ID. This sets the given server response as the default response for each request.

25. Mocks - Get a mock server's call logs

GET https://api.getpostman.com/mocks/{{mockId}}/call-logs

Gets a mock server's call logs. You can get a maximum of 6.5MB of call logs or a total of 100 call logs, whichever limit is met first in one API call.

Call logs contain exchanged request and response data made to mock servers. The logs provide visibility into how the mock servers are being used. You can log data to debug, test, analyze, and more, depending upon the use case.

26. Monitors - Create a monitor

POST https://api.getpostman.com/monitors

In Qodex v10 and higher you cannot create monitors for collections added to an API definition.

Creates a monitor. Include the following properties in the request body:

name — A string value that contains the monitor's name.
schedule — An object that contains the following properties:
- cron — A string value the monitor's run frequency. At this time you can only create monitors with limited schedules. For information about the available schedules, see our Qodex Monitors collection. See the table below for cron patterns.
- timezone — A string value that contains the monitor's timezone.
collection — A string value that contains the monitor's associated collection unique ID.
environment — A string value that contains the monitor's associated environment unique ID.

Cron patterns

Frequency	Cron Pattern
Every 5 minutes	`\\\/5 \\\ \\\* \\\* \\\*`
Every 30 minutes	`\\\/30 \\\ \\\* \\\* \\\*`
Every Hour	`0 \\\/1 \\\ \\\* \\\*`
Every 6 Hours	`0 \\\/6 \\\ \\\* \\\*`
Every day at 5pm	`0 17 \\\* \\\* \\\*`
Every Monday at 12pm	`0 12 \\\* \\\* MON`
Every weekday (Monday - Friday) at 6am	`0 6 \\\* \\\* MON-FRI`

27. Monitors - Run a monitor

POST https://api.getpostman.com/monitors/{{monitorId}}/run

Runs a monitor and returns its run results.

28. Monitors - Delete a monitor

DELETE https://api.getpostman.com/monitors/{{monitorId}}

Deletes a monitor.

29. Monitors - Get all monitors

GET https://api.getpostman.com/monitors

Gets all monitors.

30. Monitors - Get a monitor

GET https://api.getpostman.com/monitors/{{monitorId}}

Gets information about a monitor.

31. Monitors - Update a monitor

PUT https://api.getpostman.com/monitors/{{monitorId}}

Updates a monitor. Include the following properties in the request body:

name — A string value that contains the monitor's name.
schedule — An object that contains the following properties:
- cron — A string value the monitor's run frequency. At this time you can only create monitors with limited schedules. For information about the available schedules, see our Qodex Monitors collection. See the table below for cron patterns.
- timezone — A string value that contains the monitor's timezone.

Cron patterns

Frequency	Cron Pattern
Every 5 minutes	`\\/5 \\ \\* \\* \\*`
Every 30 minutes	`\\/30 \\ \\* \\* \\*`
Every Hour	`0 \\/1 \\ \\* \\*`
Every 6 Hours	`0 \\/6 \\ \\* \\*`
Every day at 5pm	`0 17 \\* \\* \\*`
Every Monday at 12pm	`0 12 \\* \\* MON`
Every weekday (Monday - Friday) at 6am	`0 6 \\* \\* MON-FRI`

32. Workspaces - Update a workspace

PUT https://api.getpostman.com/workspaces/{{workspaceId}}

Updates a workspace. You can use the following request body properties to update the workspace:

name — A string that contains the workspace's new name.
type — Optional. A string that contains the workspace type:
- personal — A personal workspace.
- team — A team workspace.
description — Optional. A string that contains the new workspace description.

Note:

You can change a workspace's type from personal to team, but you cannot change a workspace from team to personal.

Important:

We deprecated linking collections or environments between workspaces. We do not recommend that you do this.

If you have a linked collection or environment, note the following:

The endpoint does not create a clone of a collection or environment.
Any changes you make to a linked collection or environment changes them in all workspaces.
If you delete a collection or environment linked between workspaces, the system deletes it in all the workspaces.

33. Workspaces - Create a workspace

POST https://api.getpostman.com/workspaces

Creates a new [workspace] Include the following properties in the request body:

name — A string that contains the workspace's name.
type — A string that contains the workspace type:
- personal — A personal workspace.
- team — A team workspace.

You can include the following optional properties in the request body:

description — A string that contains a description of the workspace.

Important:

We deprecated linking collections or environments between workspaces. We do not recommend that you do this.

If you have a linked collection or environment, note the following:

The endpoint does not create a clone of a collection or environment.
Any changes you make to a linked collection or environment changes them in all workspaces.
If you delete a collection or environment linked between workspaces, the system deletes it in all the workspaces.

34. Workspaces - Get a workspace

GET https://api.getpostman.com/workspaces/{{workspaceId}}

Gets information about a workspace.

Note:

This endpoint's response contains the visibility field. [Visibility] determines who can access the workspace:

only-me — Applies to the My Workspace workspace.
personal — Only you can access the workspace.
team — All team members can access the workspace.
private-team — Only invited team members can access the workspace.
public — Everyone can access the workspace.

Important

We have deprecated the name and uid responses in the following array of objects:

collections
environments
mocks
monitors
apis

35. Workspaces - Delete a workspace

DELETE https://api.getpostman.com/workspaces/{{workspaceId}}

Deletes an existing workspace.

Important:

If you delete a workspace that has a linked collection or environment with another workspace, this will delete the collection and environment in all workspaces.

36. Workspaces - Get all workspaces

GET https://api.getpostman.com/workspaces

Gets all [workspaces] The response includes your workspaces and any workspaces that you have access to.

Note:

This endpoint's response contains the visibility field. [Visibility] determines who can access the workspace:

only-me — Applies to the My Workspace workspace.
personal — Only you can access the workspace.
team — All team members can access the workspace.
private-team — Only invited team members can access the workspace.
public — Everyone can access the workspace.

37. User - Get authenticated user

GET https://api.getpostman.com/me

Gets information about the authenticated user.

38. Import - Import an OpenAPI definition

POST https://api.getpostman.com/import/openapi

Imports an OpenAPI definition into Qodex as a new [Qodex Collection]

Include the following properties in the request body:

type — A string that contains the definition's type. One of:
- string
- json
- file
input — The OpenAPI definition, based on the type value:
- For string, the definition's stringified JSON object.
- For json, the definition's JSON object.
- For file, a definition file. To import a file, the request body must be a form-data request and include the type key with the file value.

You can include the following additional properties in the request body:

options — An object that contains advanced creation options and their values. You can find a complete list of properties and their values in Qodex's OpenAPI 3.0 to Qodex Collection v2.1.0 Converter OPTIONS documentation. These properties are case-sensitive.

For more information, refer to the collection's examples.

Note:

If you import with the file input method, you must use the Qodex desktop app. The Qodex web app does not support this method type.

39. Import - Import an exported Qodex data dump file

POST https://api.getpostman.com/import/exported

Imports exported Qodex data. This endpoint only accepts export data dump files.

For more information, read our [Exporting data dumps] documentation.

Important

This endpoint is deprecated.

40. API-API Version - Get all API versions

GET https://api.getpostman.com/apis/{{apiId}}/versions

Gets information about an API's versions.

In Qodex v9 and earlier:

When you create an API, the system creates a single, default API version. You can use this version’s ID with any endpoints that require an API version ID.

41. API-API Version - Create an API version

POST https://api.getpostman.com/apis/{{apiId}}/versions

This endpoint is deprecated in Qodex v10 and higher.

Creates a new API version. Include the following request body properties in the version object:

name — Required. A string that contains the API version's name.
source — An object that contains the following properties:
- id — A string that contains an API version's ID to copy to the created API version.
- schema — A boolean value. If true, copy the API definition to the new API version.
- relations — An object that contains the relation types to copy to the new API version. Each property is a boolean value that, if true, copies to the new API version. If you do not include any the following properties, the system does not copy them over (defaults to the false value):
  - monitor
  - mock
  - documentation
  - test
  - environment

42. API-API Version - Get an API version

GET https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}

Gets information about an API version.

In Qodex v9 and earlier:

When you create an API, the system creates a single, default API version. You can use this version’s ID with any endpoints that require an API version ID.

43. API-API Version - Update an API version

PUT https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}

This endpoint is deprecated in Qodex v10 and higher.

Updates an API version. Include the following request body properties in the version object:

name — A string that contains the API version's name.

44. API-API Version - Delete an API version

DELETE https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}

This endpoint is deprecated in Qodex v10 and higher.

Deletes an API version.

45. API-Relations - Get unclassified relations

GET https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/unclassified

This endpoint is for Qodex v10 and higher.

Gets all of an API version's unclassified relations.

Unclassified relations are used for documentation and testing. This is the default relation type.

46. API-Relations - Get monitor relations

GET https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/monitor

This endpoint is deprecated in Qodex v10 and higher.

Gets an API version's monitor relations.

47. API-Relations - Get documentation relations

GET https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/documentation

This endpoint is deprecated in Qodex v10 and higher.

Gets an API version's documentation relations.

48. API-Relations - Get integration test relations

GET https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/integrationtest

This endpoint is deprecated.

49. API-Relations - Get test suite relations

GET https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/testsuite

This endpoint is deprecated.

50. API-Relations - Get all linked relations

GET https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/relations

Gets all of an API version's relations.

Note:

In Qodex v10 and higher, this endpoint returns the following:

The unclassified relation is for documentation and testing. This is the default relation type.
The apiDefinition relation is the relation used for API definitions.

51. API-Relations - Get all test relations

GET https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/test

This endpoint is deprecated in Qodex v10 and higher.

Gets all of an API version's test relations.

52. API-Relations - Sync API relations with definition

PUT https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/:relationType/:entityId/syncWithSchema

Syncs an API version's relation with the API's definition.

53. API-Relations - Get environment relations

GET https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/environment

This endpoint is deprecated in Qodex v10 and higher.

Gets an API version's environment relations.

54. API-Relations - Get contract test relations

GET https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/contracttest

This endpoint is deprecated.

55. API-Relations - Create relations

POST https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/relations

Creates a new relation for an API version. Include the following in the request body:

relationType — An array that contains entity relations. The key value for this array must be the unclassified value.

You must include the following properties in the relationType array:

entityId — The collection's UID value.

Note:

The following is deprecated in Qodex API v10 and higher:

`relationType`	`entityId`
`documentation` and `test`	A collection UID value.
`environment`	An environment UID value.
`mock`	A mock ID value.
`monitor`	A monitor ID value.

The endpoint accepts multiple relationType arrays in a single call. For an example, see the example response documentation.

The documentation and test values returned in the response are the relation ID values, not the collection ID values.

56. API-Schema - Get a schema

GET https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/schemas/{{schemaId}}

This endpoint is deprecated in Qodex v10 and higher.

Gets information about an API's definition.

57. API-Schema - Create a schema

POST https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/schemas

This endpoint is deprecated in Qodex v10 and higher.

Creates an API definition. The request body must contain a schema object with the following properties:

type — A string value that contains the API definition's type. One of:
- openapi3_1
- openapi3
- openapi2
- openapi1
- raml
- raml1
- wsdl1
- wsdl2
- graphql
- proto2
- graphql
- proto3
language — A string value that contains the API definition's language. One of:
- OpenAPI and RAML — json or yaml
- GraphQL — graphql
- WSDL — xml
- Protobuf — proto
schema — A string value that contains the API definition's contents.

58. API-Schema - Create a collection from a schema

POST https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/schemas/{{schemaId}}/collections

This endpoint is deprecated in Qodex v10 and higher.

Creates a collection and links it to an API as one or multiple relations.

Include the following properties in the request body:

name — A string that contains the name of the collection.

You can also include the following additional properties in the request body:

relations — An array that contains a list of relations to create:
- contracttest — Deprecated.
- integrationtest — Deprecated.
- testsuite — Deprecated.
- documentation
options — An object that contains advanced creation options and their values. You can find a complete list of properties and their values in Qodex's OpenAPI 3.0 to Qodex Collection v2.1.0 Converter OPTIONS documentation. These properties are case-sensitive.

59. API-Schema - Update a schema

PUT https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/schemas/{{schemaId}}

This endpoint is deprecated in Qodex v10 and higher.

Updates an API definition. The request body must contain a schema object with the following properties:

type — A string value that contains the API definition's type. One of:
- openapi3_1
- openapi3
- openapi2
- openapi1
- raml
- raml1
- wsdl1
- wsdl2
- graphql
- proto2
- graphql
- proto3
language — A string value that contains the API definition's language. One of:
- OpenAPI and RAML — json or yaml
- GraphQL — graphql
- WSDL — xml
- Protobuf — proto
schema — Optional. A string value that contains the API definition's contents.

60. API-Release - Get an API release

GET https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/releases/{{apiReleaseId}}

This endpoint is deprecated in Qodex v10 and higher.

Gets information about an API version's release.

61. API-Release - Get all API releases

GET https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/releases

This endpoint is deprecated in Qodex v10 and higher.

Gets information about all of an API version's releases.

62. API-Release - Create an API release

POST https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/releases

This endpoint is deprecated in Qodex v10 and higher.

Creates a new API version release. Include the following properties in the release object:

name — A string value that contains the release name.
visibility — A string value that contains the release's visibility. One of:
- private — The release is private.
- public — The release is public.

You can include the following optional properties:

summary — A string value that contains the release's summary.
description — A string value that contains the release's description.
gitTag — A string value that contains a valid Git tag ID. The tag must exist in the API's connected Git repository.

63. API-Release - Update an API release

PATCH https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/releases/{{apiReleaseId}}

This endpoint is deprecated in Qodex v10 and higher.

Updates an API version's release. Include at least one of the following properties in the release object:

name — A string value that contains the release name.
visibility — A string value that contains the release's visibility. One of:
- private — The release is private.
- public — The release is public.
summary — A string value that contains the release's summary.
description — A string value that contains the release's description.
gitTag — A string value that contains a valid Git tag ID. The tag must exist in the API's connected Git repository.

64. API-Release - Delete an API release

DELETE https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/releases/{{apiReleaseId}}

This endpoint is deprecated in Qodex v10 and higher.

Deletes an API version's release.

65. API - Get all APIs

GET https://api.getpostman.com/apis

Gets information about all APIs.

66. API - Create an API

POST https://api.getpostman.com/apis

Creates an API. Include the following properties in the api object:

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.

67. API - Get an API

GET https://api.getpostman.com/apis/{{apiId}}

Gets information about an API.

68. API - Update an API

PUT https://api.getpostman.com/apis/{{apiId}}

Updates an API. Include at least one of the following properties in the api object:

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.

69. API - Delete an API

DELETE https://api.getpostman.com/apis/{{apiId}}

Deletes an API.

70. Webhooks - Create a webhook

POST https://api.getpostman.com/webhooks

Creates a webhook that triggers a collection with a custom payload. You can get the webhook's URL from the webhookUrl property in the endpoint's response.

Include the following properties in a webhook object in the request body:

name — The webhook's name. On success, the system creates a new monitor with this name in the Monitors tab.
collection — The collection UID to trigger when calling this webhook.

71. SCIM 2.0 - Identity-User Provisioning - Get a user resource

GET https://api.getpostman.com/scim/v2/Users/{{userId}}

Gets information about a Qodex team member.

72. SCIM 2.0 - Identity-User Provisioning - Update a user

PUT https://api.getpostman.com/scim/v2/Users/{{userId}}

Updates a user's first and last name in Qodex.

Note:

This endpoint only updates a user's first and last name and pushes it to Qodex. You cannot update any other user attributes with the SCIM API.

73. SCIM 2.0 - Identity-User Provisioning - Create a user

POST https://api.getpostman.com/scim/v2/Users

Creates a new user account in Qodex and adds the user to your organization's Qodex team. If the account does not already exist, this also activates the user so they can authenticate in to your Qodex team.

If the account already exists, the system sends the user an [email invite] to join the Qodex team. The user joins the team once they accept the invite.

By default, the system assigns new users the developer role. You can [update user roles in Qodex]

74. SCIM 2.0 - Identity-User Provisioning - Get all user resources

GET https://api.getpostman.com/scim/v2/Users

Gets information about all Qodex team members.

75. SCIM 2.0 - Identity-User Provisioning - Update a user's state

PATCH https://api.getpostman.com/scim/v2/Users/{{userId}}

Updates a user's active state in Qodex. Set the active property in the request body to one of the following values:

true — Activates the user. This lets them authenticate in to your Qodex team.
false — Removes the user from your Qodex team and deactivates the account. This blocks the user from authenticating in to Qodex.

Reactivating users

By setting the active property from false to true, this reactivates an account. This allows the account to authenticate in to Qodex and adds the account back on to your Qodex team.

76. SCIM 2.0 - Identity-Group Provisioning - Get all group resources

GET https://api.getpostman.com/scim/v2/Groups

Gets all Qodex groups within the team.

77. SCIM 2.0 - Identity-Group Provisioning - Update a group

PATCH https://api.getpostman.com/scim/v2/Groups/{{groupId}}

Updates a group's information. Using this endpoint you can:

Update a group's name.
Add or remove members from a Qodex group.

Include the following properties in the request body:

Operations — An object that contains the following properties:
- op — The operation to perform. One of:
  - add
  - remove
  - replace
- value — An object that contains the following properties:
  - id — The group's ID.
  - displayName — The group's display name.

78. SCIM 2.0 - Identity-Group Provisioning - Get a group resource

GET https://api.getpostman.com/scim/v2/Groups/{{groupId}}

Gets information about a Qodex group within the team.

79. SCIM 2.0 - Identity-Group Provisioning - Create a group

POST https://api.getpostman.com/scim/v2/Groups

Creates a new user group in Qodex and creates a new account for each group member.

Each account is added to your Qodex team and authentication is activated for each user. If an existing Qodex account uses an email that matches a group member's email ID, an email invite to join your Qodex team is sent to that user. Once the user accepts the invite, they'll be added to your team.

By default, the system assigns new users the developer role. You can [update user roles in Qodex]

80. SCIM 2.0 - Identity-Group Provisioning - Delete a group

DELETE https://api.getpostman.com/scim/v2/Groups/{{groupId}}

Deletes a group in Qodex.

User accounts that were in the deleted group are deactivated in Qodex if the app is assigned to the user only with the deleted group.

User accounts and the data corresponding to them are not deleted. To permanently delete user accounts and their data, [contact Qodex support]

81. SCIM 2.0 - Identity - Get resource types

GET https://api.getpostman.com/scim/v2/ResourceTypes

Gets all the resource types supported by Qodex's SCIM API.

82. SCIM 2.0 - Identity - Get service provider configuration

GET https://api.getpostman.com/scim/v2/ServiceProviderConfig

Gets the Qodex SCIM API configuration information. This includes a list of supported operations.

83. API Security - Schema security validation

POST https://api.getpostman.com/security/api-validation

This endpoint will perform static analysis on the Schema specification. It will return the security misses in your schema definition and help you understand their implications and possible ways to patch the warnings. You can introduce this endpoint to your CI/CD process to automate your schema validation.

Request Body(max size 10MB)

Key	Value Type	Required	Description
type	Enum(openapi3, openapi2)	Yes	Type of Schema Specification
language	Enum(json, yaml)	Yes	Format of Schema Specification
schema	String	Yes	Stringified Schema Body

Visit Learning Center for more information

84. Audit Logs - Get team audit logs

GET https://api.getpostman.com/audit/logs

Gets a list of your team's generated audit events. For a complete list of all audit events, read our [Utilizing audit logs] documentation.

85. Private API Network - Get all elements and folders

GET https://api.getpostman.com/network/private

Gets information about the folders and elements added to your [Private API Network] Elements are APIs, collections, and workspaces.

Note:

The limit and offset parameters are separately applied to elements and folders. For example, if you query a limit value of 10 and an offset value 0, the endpoint returns 10 elements and 10 folders for a total of 20 items. The totalCount property in the meta response is the total count of both elements and folders.

86. Private API Network - Add an element or folder

POST https://api.getpostman.com/network/private

Publishes a element or creates a folder in your [Private API Network] An element is a Qodex API, collection, or workspace.

Include the following in the request body object:

elementType — The Private API Network element type. Must be one of the following values:
- api
- folder
- collection
- workspace

In the elementType object, include the following values:

For APIs and Workspaces:

id — A string value that contains the element's ID.
parentFolderId — An integer value that contains the element's parent folder ID.

For Collections:

id — A string value that contains the collection's UID (userId-collectionId).
summary — A string value that contains the collection's summary.
parentFolderId — An integer value that contains the collection's parent folder ID.

For Private API Network Folders:

name — A string value that contains the folder's name.
description — A string value that contains the folder's description.
parentFolderId — An integer value that contains the folder's parent folder ID.

87. Private API Network - Update an element or folder

PUT https://api.getpostman.com/network/private/{{elementType}}/{{elementId}}

Updates an element or folder in your [Private API Network] When you call this endpoint, the elementType property must be the api, folder, collection, or workspace value.

The elementId value is the api, folder, or workspace element's ID. For collection, this value is the collection's UID (userId-collectionId).

Include the following in the request body object:

elementType — The Private API Network element type. Must be one of the following values:
- api
- folder
- collection
- workspace

In the elementType object, include the following values:

parentFolderId — The element's new Private API Network folder ID.

For Collections:

summary — A string value that contains the collection's new summary.

For Private API Network Folders:

You can include the following optional properties:

description — A string value that contains the folder's new description.
name — A string value that contains the folder's new name.

88. Private API Network - Remove an element or folder

DELETE https://api.getpostman.com/network/private/{{elementType}}/{{elementId}}

Removes an element or delete a folder from your [Private API Network]

Note:

Removing an API, collection, or workspace element does not delete it. It only removes it from the Private API Network folder.

89. Private API Network - Get all element add requests

GET https://api.getpostman.com/network/private/network-entity/request/all

Gets a list requests to add elements to the [Private API Network]

90. Private API Network - Respond to an element add request

PUT https://api.getpostman.com/network/private/network-entity/request/:id

Responds to a user's request to add an element to the [Private API Network] Include the following in the request body:

message — A string value in a response object that contains a message that details why the user's request was denied.
status — A string value that contains the request's status. One of: denied or approved