Visualize Qodex Feature Usage

Copy a Workspace

[O] Get workspace [N] Create workspace

[O] Get collection [N] Create collection

[O] Get environment [N] Create environment

[O] Get mock [N] Create mock [N] Update Mock

[O] Get monitor [N] Create monitor

APIs-For Each API

[O] Get an API [N] Create API [N] Get API's Versions for deleting draft version [O] Get all API versions

APIs-For Each API Version

[N] Create API Version [N] Add Version Summary/Stage [O] Get Version Schema [N] Create Version Schema [N] Create relations [N] Delete draft version

Decision engine

Create a Collection Backup

Get source collection and remove IDs Update destination collection

Create a Collection Backup via Transfer

Get source collection data Clean the destination collection End Copy folders to destination collection Get folder name Update folder name Copy requests to destination collection Get request name Update request name

Deactivate User Accounts

Deactivate a user

Delete Postman Elements by Tag

Get all elements by tag Delete collections with tag Delete APIs with tag Delete workspaces with tag Print results

Environment Scanner

Scan leaked key Access the contents of workspaces accessible to you Access contents of a specific environment

Weekly weather forecast Pokemon - Get details

Weekly weather forecast Pokemon - Get details Instagram - Publish Reel WhatsApp - Send Text Message Notion - Create a Page OpenAI - Create chat completion

Create a schema Create or update a schema file Get a schema Get schema files Get schema file contents Delete a schema file

API-API Version

Create a version Get all versions Get a version Update a version Delete a version

API-Collections

Get a collection Add a collection Sync collection with schema

Get an API's tags Update an API's tags

Get an API's comments Create an API comment Update an API's comment Delete an API's comment

Get all APIs Get an API Delete an API Get status of an asynchronous task Update an API Create an API

API definition security validation

Get team audit logs

Get accounts List account invoices

Collections-Items-Folders-Comments

Get a folder's comments Create a folder comment Update a folder's comment Delete a folder's comment

Collections-Items-Folders

Get a folder Create a folder Update a folder Delete a folder

Collections-Items-Requests-Comments

Get a request's comments Create a request comment Update a request's comment Delete a request's comment

Collections-Items-Requests

Get a request Create a request Update a request Delete a request

Collections-Items-Responses-Comments

Get a response's comments Create a response comment Update a response's comment Delete a response's comment

Collections-Items-Responses

Get a response Create a response Update a response Delete a response

Collections-Tags

Get a collection's tags Update a collection's tags

Collections-Forks

Get a collection's forks Get source collection's status Get all forked collections Pull source changes Create a fork Merge a fork

Collections-Pull Requests

Get a collection's pull requests Create a pull request

Collections-Transformations

Transform collection to OpenAPI

Collections-Transfers

Transfer folders Transfer requests Transfer responses

Collections-Roles

Get a collection's roles Update a collection's roles

Collections-Comments

Get a collection's comments Create a collection comment Update a collection's comment Delete a collection's comment

Collections-Collection Access Keys

Get collection access keys Delete a collection access key

Create a collection Get a collection Delete a collection Replace a collection's data Update part of a collection Get all collections

Environments-Forks

Get an environment's forks Create a fork Pull source changes Merge a fork

Get an environment Delete an environment Create an environment Update an environment Get all environments

Import an OpenAPI definition

Mocks-Call Logs

Get a mock server's call logs

Mocks-Server Responses

Get a server response Get all server responses Create a server response Update a server response Delete a server response

Get a mock server Create a mock server Get all mock servers Delete a mock server Unpublish a mock server Publish a mock server Update a mock server

Create a monitor Run a monitor Delete a monitor Get all monitors Get a monitor Update a monitor

Private API Network-Element Requests

Respond to an element add request Get all element add requests

Private API Network

Get all elements and folders Add an element or folder Update an element or folder Remove an element or folder

Get a pull request Review a pull request Update a pull request

SCIM-User Provisioning

Get a user resource Update a user Create a user Get all user resources Update a user's state

SCIM-Group Provisioning

Get all group resources Update a group Get a group resource Create a group Delete a group

Get resource types Get service provider configuration

Secret Scanner-Detected Secrets

Update detected secret resolution status Get detected secrets locations Search detected secrets

Get secret types

Get elements by tag

Get authenticated user

Create a webhook

Workspaces-Tags

Get a workspace's tags Update a workspace's tags

Workspaces-Global Variables

Get global variables Update global variables

Workspaces-Roles

Get all roles Update user or user group roles

Update a workspace Create a workspace Get a workspace Get all workspaces Delete a workspace

DEPRECATED-API-v9-API Version

Get all API versions Create an API version Get an API version Update an API version Delete an API version

DEPRECATED-API-v9-Relations

Get unclassified relations Get monitor relations Get documentation relations Get integration test relations Get test suite relations Get all linked relations Get all test relations Sync API relations with definition Get environment relations Get contract test relations Create relations

DEPRECATED-API-v9-Schema

Get a schema Create a schema Create a collection from a schema Update a schema

DEPRECATED-API-v9-Release

Get an API release Get all API releases Create an API release Update an API release Delete an API release

DEPRECATED-API-v9

Get all APIs Create an API Get an API Update an API Delete an API

DEPRECATED-Import

Import an exported Qodex data dump file

Postman Assets Scaffolding

Git Repository Requests-Azure DevOps

[Azure] Create OAuth Token [Azure] YAML

Git Repository Requests-Bitbucket

[Bitbucket] JSON [Bitbucket] YAML

Git Repository Requests-GitHub

[GitHub] JSON [GitHub] YAML

Git Repository Requests-GitLab

[GitLab] JSON [GitLab] YAML

Asset Generation

Create New Workspace Create API Create Schema - YAML Create Collection from Schema Get Collection from API Builder Create Collection for Mock Server Create Mock Server Create Environment Create Monitor Create API Version Add API to Private API Network

Postman to JMeter

Generate a JMeter Test Plan

Postman to Markdown

Generate Markdown

Postman to OpenAPI

Generate an OpenAPI Schema

Postman to Swagger (OAS 2)

Generate a Swagger Schema

Decision Engine

[N] Get details Decision engine

[O] Get all workspaces [O] Get workspace [N] Create workspace

[O] Get collection [N] Create collection

[O] Get environment [N] Create environment

[O] Get monitor [N] Create monitor

[O] Get mock [N] Create mock [N] Update Mock

APIs-For Each API

[O] Get an API [N] Create API [N] Get API's Versions for deleting draft version [O] Get all API versions

APIs-For Each API Version

[N] Create API Version [N] Add Version Summary/Stage [O] Get Version Schema [N] Create Version Schema [N] Create relations [N] Delete draft version

Visualize Qodex Feature Usage

Copy a Workspace

[O] Get workspace [N] Create workspace

[O] Get collection [N] Create collection

[O] Get environment [N] Create environment

[O] Get mock [N] Create mock [N] Update Mock

[O] Get monitor [N] Create monitor

APIs-For Each API

[O] Get an API [N] Create API [N] Get API's Versions for deleting draft version [O] Get all API versions

APIs-For Each API Version

[N] Create API Version [N] Add Version Summary/Stage [O] Get Version Schema [N] Create Version Schema [N] Create relations [N] Delete draft version

Decision engine

Create a Collection Backup

Get source collection and remove IDs Update destination collection

Create a Collection Backup via Transfer

Get source collection data Clean the destination collection End Copy folders to destination collection Get folder name Update folder name Copy requests to destination collection Get request name Update request name

Deactivate User Accounts

Deactivate a user

Delete Postman Elements by Tag

Get all elements by tag Delete collections with tag Delete APIs with tag Delete workspaces with tag Print results

Environment Scanner

Scan leaked key Access the contents of workspaces accessible to you Access contents of a specific environment

Weekly weather forecast Pokemon - Get details

Weekly weather forecast Pokemon - Get details Instagram - Publish Reel WhatsApp - Send Text Message Notion - Create a Page OpenAI - Create chat completion

Create a schema Create or update a schema file Get a schema Get schema files Get schema file contents Delete a schema file

API-API Version

Create a version Get all versions Get a version Update a version Delete a version

API-Collections

Get a collection Add a collection Sync collection with schema

Get an API's tags Update an API's tags

Get an API's comments Create an API comment Update an API's comment Delete an API's comment

Get all APIs Get an API Delete an API Get status of an asynchronous task Update an API Create an API

API definition security validation

Get team audit logs

Get accounts List account invoices

Collections-Items-Folders-Comments

Get a folder's comments Create a folder comment Update a folder's comment Delete a folder's comment

Collections-Items-Folders

Get a folder Create a folder Update a folder Delete a folder

Collections-Items-Requests-Comments

Get a request's comments Create a request comment Update a request's comment Delete a request's comment

Collections-Items-Requests

Get a request Create a request Update a request Delete a request

Collections-Items-Responses-Comments

Get a response's comments Create a response comment Update a response's comment Delete a response's comment

Collections-Items-Responses

Get a response Create a response Update a response Delete a response

Collections-Tags

Get a collection's tags Update a collection's tags

Collections-Forks

Get a collection's forks Get source collection's status Get all forked collections Pull source changes Create a fork Merge a fork

Collections-Pull Requests

Get a collection's pull requests Create a pull request

Collections-Transformations

Transform collection to OpenAPI

Collections-Transfers

Transfer folders Transfer requests Transfer responses

Collections-Roles

Get a collection's roles Update a collection's roles

Collections-Comments

Get a collection's comments Create a collection comment Update a collection's comment Delete a collection's comment

Collections-Collection Access Keys

Get collection access keys Delete a collection access key

Create a collection Get a collection Delete a collection Replace a collection's data Update part of a collection Get all collections

Environments-Forks

Get an environment's forks Create a fork Pull source changes Merge a fork

Get an environment Delete an environment Create an environment Update an environment Get all environments

Import an OpenAPI definition

Mocks-Call Logs

Get a mock server's call logs

Mocks-Server Responses

Get a server response Get all server responses Create a server response Update a server response Delete a server response

Get a mock server Create a mock server Get all mock servers Delete a mock server Unpublish a mock server Publish a mock server Update a mock server

Create a monitor Run a monitor Delete a monitor Get all monitors Get a monitor Update a monitor

Private API Network-Element Requests

Respond to an element add request Get all element add requests

Private API Network

Get all elements and folders Add an element or folder Update an element or folder Remove an element or folder

Get a pull request Review a pull request Update a pull request

SCIM-User Provisioning

Get a user resource Update a user Create a user Get all user resources Update a user's state

SCIM-Group Provisioning

Get all group resources Update a group Get a group resource Create a group Delete a group

Get resource types Get service provider configuration

Secret Scanner-Detected Secrets

Update detected secret resolution status Get detected secrets locations Search detected secrets

Get secret types

Get elements by tag

Get authenticated user

Create a webhook

Workspaces-Tags

Get a workspace's tags Update a workspace's tags

Workspaces-Global Variables

Get global variables Update global variables

Workspaces-Roles

Get all roles Update user or user group roles

Update a workspace Create a workspace Get a workspace Get all workspaces Delete a workspace

DEPRECATED-API-v9-API Version

Get all API versions Create an API version Get an API version Update an API version Delete an API version

DEPRECATED-API-v9-Relations

Get unclassified relations Get monitor relations Get documentation relations Get integration test relations Get test suite relations Get all linked relations Get all test relations Sync API relations with definition Get environment relations Get contract test relations Create relations

DEPRECATED-API-v9-Schema

Get a schema Create a schema Create a collection from a schema Update a schema

DEPRECATED-API-v9-Release

Get an API release Get all API releases Create an API release Update an API release Delete an API release

DEPRECATED-API-v9

Get all APIs Create an API Get an API Update an API Delete an API

DEPRECATED-Import

Import an exported Qodex data dump file

Postman Assets Scaffolding

Git Repository Requests-Azure DevOps

[Azure] Create OAuth Token [Azure] YAML

Git Repository Requests-Bitbucket

[Bitbucket] JSON [Bitbucket] YAML

Git Repository Requests-GitHub

[GitHub] JSON [GitHub] YAML

Git Repository Requests-GitLab

[GitLab] JSON [GitLab] YAML

Asset Generation

Create New Workspace Create API Create Schema - YAML Create Collection from Schema Get Collection from API Builder Create Collection for Mock Server Create Mock Server Create Environment Create Monitor Create API Version Add API to Private API Network

Postman to JMeter

Generate a JMeter Test Plan

Postman to Markdown

Generate Markdown

Postman to OpenAPI

Generate an OpenAPI Schema

Postman to Swagger (OAS 2)

Generate a Swagger Schema

Decision Engine

[N] Get details Decision engine

[O] Get all workspaces [O] Get workspace [N] Create workspace

[O] Get collection [N] Create collection

[O] Get environment [N] Create environment

[O] Get monitor [N] Create monitor

[O] Get mock [N] Create mock [N] Update Mock

APIs-For Each API

[O] Get an API [N] Create API [N] Get API's Versions for deleting draft version [O] Get all API versions

APIs-For Each API Version

[N] Create API Version [N] Add Version Summary/Stage [O] Get Version Schema [N] Create Version Schema [N] Create relations [N] Delete draft version

Home Postman API APIDelete an API

Delete an API

DELETE {{baseUrl}}/apis/{{apiId}}

Deletes an API. On success, this returns an HTTP 204 No Content response.

HEADERS

Key	Datatype	Required	Description
`Accept`	string

Get status of an asynchronous task