Postman API

Creates a schema for an API. Include the following in the the request body:

• type — A string value that contains the API schema's type. One of:
  • openapi:3_1
  • openapi:3
  • openapi:2
  • openapi:1
  • raml:0_8
  • raml:1
  • wsdl:1
  • wsdl:2
  • graphql
  • proto:2
  • proto:3
  • asyncapi:2
• files — An array of schema files that contains the following:
  • path — A string value that contains the schema file's path.
  • content — A string value that contains the schema file's stringified contents.

Creates or updates an API schema file. Include the following in the request body:

• content — A string value that contains the file's contents.

Note:

• If the provided file path exists, the file will be updated with the new contents.
• If the provided file path does not exist, then a new schema file will be created.
• If the file path contains a / (forward slash) character, then a folder is created. For example, if the file path is the dir/schema.json value, then a dir folder is created with the schema.json file inside.
• You can only update the root tag for protobuf specifications.

Gets information about API schema. You can use the versionId query parameter to get a schema published in an API version.

You can use this API to do the following:

• Get a schema's metadata.
• Get all the files in a schema. This only returns the first file in the schema. The endpoint response contains a link to the next set of response results.
• Get a schema's contents in multi-file or bundled format.

Note:

The versionId query parameter is a required parameter for API viewers.

Gets the files in an API schema. You can use the versionId query parameter to get schema files published in an API version.

Note:

The versionId query parameter is a required parameter for API viewers.

Gets an API schema file contents at the defined path. You can use the versionId query parameter to get schema file contents published in an API version.

Note:

The versionId query parameter is a required parameter for API viewers.

Deletes a file in an API schema.

Creates a new API version asynchronously and immediately returns an HTTP 202 Accepted response. The response contains a polling link to the task status API in the Location header.

This endpoint is equivalent to publishing a version in Qodex app, which is the snapshot of API collections and schema at a given point in time.

Include the following properties in the request body:

• name — A string value that contains the version name.
• collections — An array containing all the collections to publish.
• schemas — An array containing the schema to publish.
• branch — A string value that contains the name of the repository branch. This property is required only for Git-linked APIs.

You can include the following optional properties:

• releaseNotes — A string value that contains the Markdown-supported version summary.

Gets all the published versions of an API.

Gets information about an API version.

Note:

• For API editors, this endpoint returns an HTTP 302 Found status code when the version status is pending. It also returns the /apis/{apiId}/tasks/{taskId} task status response header.
• For API viewers, this endpoint returns an HTTP 404 Not Found when the version status is pending.

Updates an API version. Include at least one of the following properties in the request body:

• name — A string value that contains the version name.
• releaseNotes — A string value that contains the Markdown-supported release notes.

Note:

This endpoint returns an HTTP 404 Not Found response when an API version is pending publication.

Deletes an API version.

Note:

This endpoint returns an HTTP 404 Not Found response when an API version is pending publication.

Gets a collection attached to an API. You can use the versionId query parameter to get a collection published in a version.

Note:

The versionId query parameter is a required parameter for API viewers.

Adds a collection to an API. To do this, use the following operationType values:

• COPY_COLLECTION — Copies a collection from the workspace and adds it to an API.
• CREATE_NEW — Creates a new collection by providing the new collection's content.

• GENERATE_FROM_SCHEMA — Generates the collection from an API schema.

  • 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 examples of each method, see the collection's response examples.

Syncs a collection attached to an API with the API schema. This is an asynchronous endpoint that returns an HTTP 202 Accepted response.

The response contains a polling link to the /apis/{apiId}/tasks/{taskId} endpoint in the Location header.

Note:

This endpoint only supports the OpenAPI 3 schema type.

Gets all the tags associated with an API.

Gets all the tags associated with an API. This endpoint replaces all existing tags with those you pass in the request body.

Note:

• You can only add a maximum of five tags to an API.

• Tags must be between 2 and 64 characters long.

• Tags must follow the ^[a-z][a-z0-9-]\\\\\*[a-z0-9]+$ pattern.

Gets all comments left by users in an API.

Creates a comment on an API. Include the following in request body:

• body — (Required) A string that contains the comment.

• tags — An object that contains information about users tagged in the body comment. Include the following in this object:

  • userName — (Required) An object that contains information about the tagged user. The object's name is the user's Qodex username. For example, @user-Qodex. Include the following in this object:

    • type — (Required) A string that contains the user value.
    • id — (Required) An integer that contains the user's ID.

Note:

This endpoint accepts a max of 10,000 characters.

Updates a comment on an API. Include the following in request body:

• body — (Required) A string that contains the updated comment.

• tags — An object that contains information about users tagged in the body comment. Include the following in this object:

  • userName — (Required) An object that contains information about the tagged user. The object's name is the user's Qodex username. For example, @user-Qodex. Include the following in this object:

    • type — (Required) A string that contains the user value.
    • id — (Required) An integer that contains the user's ID.

Note:

This endpoint accepts a max of 10,000 characters.

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

Note:

Deleting the first comment of a thread deletes all the comments in the thread.

Gets information about all APIs in a workspace.

Note:

This endpoint only returns APIs created or migrated in Qodex v10 and higher.

Gets information about an API.

Note:

• Git-connected APIs will only return the 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.
• API viewers can only use the versions option in the include query parameter.

Deletes an API.

Gets the status of an asynchronous task.

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.

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

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

Performs an analysis on the given definition and returns any issues based on your [predefined rulesets] This endpoint can help you understand the violations' impact and offers solutions to help you resolve any errors. You can include this endpoint to your CI/CD process to automate schema validation.

For more information, see our [Rule violations in the API definition] documentation.

Include the following properties in the request body:

• type — A string value that contains the API definition's type. One of:
  • openapi3
  • openapi2
• language — A string value that contains the API definition's language. One of:
  • json
  • yaml
• schema — A string value that contains the API definition's contents.

Note:

• The maximum allowed size of the definition is 10 MB.
• You must [import and enable] OWASP security rules in Qodex for this endpoint to return any security rule violations.

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

Gets Qodex billing account details for the given team.

Gets all invoices for a Qodex billing account filtered by the status of the invoice.

Gets all comments left by users in a folder.

Creates a comment on a folder. Include the following in request body:

• body — (Required) A string that contains the comment.

• tags — An object that contains information about users tagged in the body comment. Include the following in this object:

  • userName — (Required) An object that contains information about the tagged user. The object's name is the user's Qodex username. For example, @user-Qodex. Include the following in this object:

    • type — (Required) A string that contains the user value.
    • id — (Required) An integer that contains the user's ID.

Note:

This endpoint accepts a max of 10,000 characters.

Updates a comment on a folder. Include the following in request body:

• body — (Required) A string that contains the comment.

• tags — An object that contains information about users tagged in the body comment. Include the following in this object:

  • userName — (Required) An object that contains information about the tagged user. The object's name is the user's Qodex username. For example, @user-Qodex. Include the following in this object:

    • type — (Required) A string that contains the user value.
    • id — (Required) An integer that contains the user's ID.

Note:

This endpoint accepts a max of 10,000 characters.

Deletes a comment from a folder. On success, this returns an HTTP 204 No Content response.

Note:

Deleting the first comment of a thread deletes all the comments in the thread.

Gets information about a folder in a collection.

Creates a folder in a collection. For a complete list of properties, refer to Folder in the [collection.json schema file]

You can use this endpoint to to import requests and responses into a newly-created folder. To do this, include the requests field and the list of request objects in the request body. For more information, see the provided examples.

Note:

It is recommended that you pass the name property in the request body. If you do not, the system uses a null value. As a result, this creates a folder with a blank name.

Updates a folder in a collection. For a complete list of properties, refer to Folder in the [collection.json schema file]

Note:

This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the name property). The endpoint does not update the entire resource.

Deletes a folder in a collection.

Gets all comments left by users in a request.

Creates a comment on a request. Include the following in request body:

• body — (Required) A string that contains the comment.

• tags — An object that contains information about users tagged in the body comment. Include the following in this object:

  • userName — (Required) An object that contains information about the tagged user. The object's name is the user's Qodex username. For example, @user-Qodex. Include the following in this object:

    • type — (Required) A string that contains the user value.
    • id — (Required) An integer that contains the user's ID.

Note:

This endpoint accepts a max of 10,000 characters.

Updates a comment on a request. Include the following in request body:

• body — (Required) A string that contains the comment.

• tags — An object that contains information about users tagged in the body comment. Include the following in this object:

  • userName — (Required) An object that contains information about the tagged user. The object's name is the user's Qodex username. For example, @user-Qodex. Include the following in this object:

    • type — (Required) A string that contains the user value.
    • id — (Required) An integer that contains the user's ID.

Note:

This endpoint accepts a max of 10,000 characters.

Deletes a comment from a request. On success, this returns an HTTP 204 No Content response.

Note:

Deleting the first comment of a thread deletes all the comments in the thread.

Gets information about a request in a collection.

Creates a request in a collection. For a complete list of properties, see the [Collection Format Request documentation]

Note:

It is recommended that you pass the name property in the request body. If you do not, the system uses a null value. As a result, this creates a request with a blank name.

Updates a request in a collection. For a complete list of properties, see the [Collection Format Request documentation]

Note:

• You must pass a collection ID (12ece9e1-2abf-4edc-8e34-de66e74114d2), not a collection UID (12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2), in this endpoint.
• This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the name property). The endpoint does not update the entire resource.
• This endpoint does not support changing the folder of a request.

Deletes a request in a collection.

Gets all comments left by users in a response.

Creates a comment on a response. Include the following in request body:

• body — (Required) A string that contains the comment.

• tags — An object that contains information about users tagged in the body comment. Include the following in this object:

  • userName — (Required) An object that contains information about the tagged user. The object's name is the user's Qodex username. For example, @user-Qodex. Include the following in this object:

    • type — (Required) A string that contains the user value.
    • id — (Required) An integer that contains the user's ID.

Note:

This endpoint accepts a max of 10,000 characters.

Updates a comment on a response. Include the following in request body:

• body — (Required) A string that contains the comment.

• tags — An object that contains information about users tagged in the body comment. Include the following in this object:

  • userName — (Required) An object that contains information about the tagged user. The object's name is the user's Qodex username. For example, @user-Qodex. Include the following in this object:

    • type — (Required) A string that contains the user value.
    • id — (Required) An integer that contains the user's ID.

Note:

This endpoint accepts a max of 10,000 characters.

Deletes a comment from a response. On success, this returns an HTTP 204 No Content response.

Note:

Deleting the first comment of a thread deletes all the comments in the thread.

Gets information about a response in a collection.

Creates a request response in a collection. For a complete list of properties, see the [Collection Format Response documentation]

Note:

It is recommended that you pass the name property in the request body. If you do not, the system uses a null value. As a result, this creates a response with a blank name.

Updates a response in a collection. For a complete list of properties, see the [Collection Format Response documentation]

Note:

• You must pass a collection ID (12ece9e1-2abf-4edc-8e34-de66e74114d2), not a collection UID (12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2), in this endpoint.
• This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the name property). The endpoint does not update the entire resource.

Deletes a response in a collection.

Gets all the tags associated with a collection.

Updates a collection's associated tags. This endpoint replaces all existing tags with those you pass in the request body.

Note:

• You can only add a maximum of five tags to a collection.

• Tags must be between 2 and 64 characters long.

• Tags must follow the ^[a-z][a-z0-9-]\\\\\*[a-z0-9]+$ pattern.

Gets a collection's forked collections. The response returns data for each fork, such as the fork's ID, the user who forked it, and the fork's creation date.

Checks whether there is a change between the forked collection and its parent (source) collection.

If the value of the isSourceAhead property is true in the response, then there is a difference between the forked collection and its source collection.

Note:

This endpoint may take a few minutes to return an updated isSourceAhead status.

Gets a list of all the authenticated user's forked collections.

Pulls the changes from a parent (source) collection into the forked collection. In the endpoint's response:

• The destinationId is the ID of the forked collection.
• The sourceId is the ID of the source collection.

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

• label — A string value that contains the fork's label.

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

• source — A string value that contains the source collection's ID.

• destination — A string value that contains the destination (parent) collection's ID.

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

• strategy — A string value that contains the fork's merge strategy. One of:

  • deleteSource — Merge the changes into the parent collection. After the merge process is complete, Qodex deletes the fork. You must have Editor access to both the parent and forked collections.
  • updateSourceWithDestination — (Default) Merge the changes into the parent collection. Any differences in the parent collection are also made to the fork.

Gets information about a collection's pull requests, such as the source and destination IDs, status of the pull requests, and a URL link to the pull requests.

Creates a pull request for a forked collection into its parent collection. Include the following in the request body:

• title — (Required) A string that contains the title of the pull request.

• reviewers — (Required) An array of strings that contains a list of the pull request's assigned reviewers.

• destinationId — (Required) A string that contains the collection ID to merge the pull request into.

• description — (Required) A string that contains a description of the pull request.

Transforms an existing Qodex Collection into a stringified OpenAPI definition.

Note:

This does not create an API.

Copies or moves folders into a collection or folder. Include the following in the request body:

• ids — A list of string values that contain the folder UIDs to transfer.

• target — An object that contains the transfer destination information:

  • model — A string value that contains the the type of item where the items will be transferred to. Accepts the collection or folder values.
  • id — The string value that contains the UID of the destination collection or folder.

• location — An object that contains the transfered item's source information:

  • position — A string value that contains the item's position within the destination object. Accepts the start, end, before, and after values.
  • model — For the before or after positions, a string value that contains the type of item (model) that the transferred item will be positioned by.
  • id — For the before or after positions, a string value that contains the model's UID.

• mode — A string value that contains the transfer operation to perform. Accepts the move or copy value.

Copies or moves requests into a collection or folder. Include the following in the request body:

• ids — A list of string values that contain the request UIDs to transfer.

• target — An object that contains the transfer destination information:

  • model — A string value that contains the the type of item where the items will be transferred to. Accepts the collection or folder values.
  • id — The string value that contains the UID of the destination collection or folder.

• location — An object that contains the transfered item's source information:

  • position — A string value that contains the item's position within the destination object. Accepts the start, end, before, and after values.
  • model — For the before or after positions, a string value that contains the type of item (model) that the transferred item will be positioned by.
  • id — For the before or after positions, a string value that contains the model's UID.

• mode — A string value that contains the transfer operation to perform. Accepts the move or copy value.

Copies or moves responses into a request. Include the following in the request body:

• ids — A list string values that contain the response UIDs to transfer.

• target — An object that contains the transfer destination information:

  • model — A string value that contains the the type of item where the items will be transferred to. Only accepts the request value.
  • id — The string value that contains the UID of the destination request.

• location — An object that contains the transfered item's source information:

  • position — A string value that contains the item's position within the destination object. Accepts the start, end, before, and after values.
  • model — For the before or after positions, a string value that contains the type of item (model) that the transferred item will be positioned by. Only accepts the response value.
  • id — For the before or after positions, a string value that contains the model's UID.

• mode — A string value that contains the transfer operation to perform. Accepts the move or copy value.

Gets information about all [roles] in a collection. The response returns the IDs of all users, teams, and groups with access to view or edit the collection.

Updates the roles of users, groups, or teams in a collection. On success, this returns a 204 No Content response.

Include the following values in the roles array of objects:

• op — (Required) A string value that contains the operation to perform. Accepts the update value.

• path — (Required) A string value that contains the resource to perform the action on. Accepts the /user, /group, or /team value.

• value — (Required) A list of objects that contain the following values:

  • id — (Required) An integer value that contains the user, group, or team ID.

  • role — (Required) A string value that contains the role's type:

    • EDITOR — Can edit collections directly.
    • VIEWER — Can view, fork, and export collections.

Note:

• Only users assigned the EDITOR [role] in the collection can use this endpoint.
• This endpoint does not support the external [Partner or Guest roles]

Gets all comments left by users in a collection.

Creates a comment on a collection. Include the following in request body:

• body — (Required) A string that contains the comment.

• tags — An object that contains information about users tagged in the body comment. Include the following in this object:

  • userName — (Required) An object that contains information about the tagged user. The object's name is the user's Qodex username. For example, @user-Qodex. Include the following in this object:

    • type — (Required) A string that contains the user value.
    • id — (Required) An integer that contains the user's ID.

Note:

This endpoint accepts a max of 10,000 characters.

Updates a comment on a collection. Include the following in request body:

• body — (Required) A string that contains the comment.

• tags — An object that contains information about users tagged in the body comment. Include the following in this object:

  • userName — (Required) An object that contains information about the tagged user. The object's name is the user's Qodex username. For example, @user-Qodex. Include the following in this object:

    • type — (Required) A string that contains the user value.
    • id — (Required) An integer that contains the user's ID.

Note:

This endpoint accepts a max of 10,000 characters.

Deletes a comment from a collection. On success, this returns an HTTP 204 No Content response.

Note:

Deleting the first comment of a thread deletes all the comments in the thread.

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

For more information about the Collection Format, see the [Qodex Collection Format documentation]

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]

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

Deletes a collection.

Replaces the contents of a collection using the [Qodex Collection v2 schema format] Include the collection's ID values in the request body. If you do not, the endpoint removes the existing items and creates new items.

The maximum collection size this endpoint accepts cannot exceed 20 MB.

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 value 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 collection's information.

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 "#/definitions/info".
• item object — Use "#/definitions/item".

For all other possible values, refer to the [collection.json schema file] For more information about the Collection Format, see the [Qodex Collection Format documentation]

Note:

To copy another collection's contents to the given collection, remove all ID values before you pass it in this endpoint. If you do not, this endpoint returns an error. These values include the id, uid, and Qodex_id values.

Updates specific collection information, such as its name, events, or its variables. For more information about the auth, variables, and events properties, refer to the [collection.json schema file]

• For variables, refer to "#/definitions/variable".
• For auth, refer to "#/definitions/auth-attribute".
• For events, refer to "#/definitions/event".

For more information about the Collection Format, see the [Qodex Collection Format documentation]

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

Gets all of an environment's forked environments.

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

• forkName — A string value that contains the forked environment's [label]

[Pulls] the changes from a parent (source) environment into the forked environment. Include the following in the request body:

• source — A string value that contains the unique ID of the environment to pull data from.

[Merges] a forked environment back into its parent environment. Include the following in the request body:

• source — A string value that contains the source environment's unique ID to merge data from.
• deleteSource — A boolean value that, if true, deletes the forked environment when it merges.

Gets information about an environment.

Deletes an environment.

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

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

You can also include the following properties:

• values — An array of objects that contains the following:

  • key — A string value that contains the variable's name.
  • value — A string value that contains the variable's value.
  • enabled — A boolean value that, if true, enable the variable.
  • type — A string value that contains the variable's type. One of: secret, default, or any.

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

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

• values — An array of objects that contains the following:

  • key — A string value that contains the variable's name.
  • value — A string value that contains the variable's value.
  • enabled — A boolean value that, if true, enable the variable.
  • type — A string value that contains the variable's type. One of: secret, default, or any.

Gets information about all of your [environments]

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

Include the following properties in the request body:

• type — A string value 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.

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.

Gets information about a server response.

Gets all of a mock server's 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 value that contains the server response's name.

• statusCode — An integer value 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 value that contains the header's key.
  • value — A string value that contains the header key's value. This value defines the corresponding value for the header key.

• body — A string value that contains a response body that returns when you call the mock server.

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

• name — A string value that contains the server response's name.

• statusCode — A string value 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 value that contains the header's key.
  • value — A string value that contains the header key's value. This value defines the corresponding value for the header key.

• body — A string value that contains a response body that returns when you call the mock server.

Deletes a mock server's server response.

Gets information about a mock server.

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

• collection — A string value that contains the collection UID.

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

• environment — A string value that contains the environment UID to associate with the mock server.
• name — A string value that contains the the mock server's name.
• private — A boolean value that, if true, sets the mock server as private. By default, mock servers are public and can receive requests from anyone and anywhere.

Note:

You cannot create mocks for collections added to an API definition.

Gets all mock servers. By default, this endpoint returns only mock servers you created across all workspaces.

Note:

If you pass both the teamId and workspace query parameters, this endpoint only accepts the workspace query.

Deletes a mock server.

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

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

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

• name — A string value that contains the mock server's name.

• environment — A string value that contains the environment UID.

• private — A boolean value that, if true, sets the mock server as private. By default, mock servers are public and can receive requests from anyone and anywhere.

• versionTag — A string value that contains the API's version tag ID.

• config — An object that contains the following properties:

  • serverResponseId — A string value that contains the server response ID. This sets the given server response as the default response for each request.

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

Note:

You cannot create monitors for collections added to an API definition.

Runs a monitor and returns its run results.

Deletes a monitor.

Gets all monitors.

Gets information about a monitor.

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

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

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

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.

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. The object's name must be one of the following:
  • 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).
• parentFolderId — An integer value that contains the collection's parent folder ID.
• environments — An array of strings that contains environment UIDs (userId-environmentId).

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. To create a folder at the root level, omit this property from the request body.

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. The object's name must be one of the following:
  • api
  • folder
  • collection
  • workspace

In the elementType object, include the following values:

• parentFolderId — A string value that contains 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.

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.

Gets information about a pull request, such as the source and destination details, who reviewed the pull request, the merge's current status, and whether the element is accessible.

Updates an open pull request. Include the following in the request body:

• title — (Required) A string that contains the title of the pull request.
• description — A string that contains a description of the pull request.
• reviewers — (Required) An array of strings that contains an updated list of the pull request's assigned reviewers. This replaces all existing users assigned to the pull request with those you pass in the request body.

Gets information about a Qodex team member.

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.

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]

Gets information about all Qodex team members.

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.

Gets all Qodex groups within the team.

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.

Gets information about a Qodex group within the team.

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]

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]

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

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

Updates the resolution status of a secret detected in a workspace.

Include the following in the request body:

• resolution — A string value that contains the secret's updated resolution status:

  • FALSE_POSITIVE — The discovered secret is not an actual secret.
  • REVOKED — The secret is valid, but the user rotated their key to resolve the issue.
  • ACCEPTED_RISK — The Secret Scanner found the secret, but user accepts the risk of publishing it.

• workspaceId — A string value that contains the ID of the workspace that contains the secret.

Gets the locations of secrets detected by Qodex's [Secret Scanner]

Returns all secrets detected by Qodex's [Secret Scanner] grouped by workspace. If you pass an empty request body, this endpoint returns all results.

You can include the following properties in the request body:

• secretTypes — An array that contains a list of secrets types to query. For a list of valid IDs, use the GET /secret-types endpoint.

• resolved — A boolean value that, if true, return secrets with a resolved status.

• statuses — An array that contains a list of the secret resolution status type:

  • FALSE_POSITIVE — The discovered secret is not an actual secret.
  • REVOKED — The secret is valid, but the user rotated their key to resolve the issue.
  • ACCEPTED_RISK — The Secret Scanner found the secret, but user accepts the risk of publishing it.

• workspaceIds — An array that contains a list of workspaces IDs to query.

• workspaceVisibilities — An array that contains a list of workspace [visibility settings] to query. This currently supports the team and public settings.

Gets the metadata of the secret types supported by Qodex's [Secret Scanner] You can use a secret type's ID in the response to query data with the POST /detected-secrets/{secretId} endpoint.

Gets Qodex elements (entities) by a given tag. Tags enable you to organize and search [workspaces] [APIs] and [collections] that contain shared tags.

Note:

Tagging is available on [Qodex Enterprise plans]

Gets information about the authenticated user.

Note:

This API returns a different response for users with the [Guest role]

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 — A string value that contains the webhook's name. On success, the system creates a new monitor with this name in the Monitors tab.

• collection — A string value that contains the collection UID to trigger when calling this webhook.

Gets all the tags associated with a workspace.

Updates a workspace's associated tags. This endpoint replaces all existing tags with those you pass in the request body.

Note:

• You can only add a maximum of five tags to an API.

• Tags must be between 2 and 64 characters long.

• Tags must follow the ^[a-z][a-z0-9-]\\\\\*[a-z0-9]+$ pattern.

Gets a workspace's global [variables]

Updates and replaces a workspace's global [variables] This endpoint replaces all existing global variables with the variables you pass in the request body:

• key — A string value that contains the variable's name.

• type — A string value that contains the [type] of variable. Accepts default or secret.

• value — A string value that contains the variable's value.

• enabled — A boolean value that, if true, enables the variable.

Gets information about all roles in a workspace, based on the team's [plan]

Updates the roles of users or [user groups] in a workspace. To get a list of roles, use the [GET /workspace-roles] endpoint.

Include the following values in the roles array of objects:

• op — (Required) A string value that contains the operation to perform. Accepts the add or remove value.

• path — (Required) A string value that contains the resource to perform the action on. Accepts the /user or /usergroup value.

• value — (Required) A list of objects that contain user or user group IDs and an assigned role ID.

  • id — (Required) A string value that contains the user or user group ID.

  • role — (Required) A number value that contains the workspace role's ID:

    • 1 — Viewer. Can view, fork, and export workspace resources
    • 2 — Editor. Can create and edit workspace resources.
    • 3 — Admin. Can manage workspace details and members.

Note:

• This endpoint does not support the external [Partner or Guest roles]
• This endpoint is restricted to 50 operations per call.
• The request body must contain one unique action per user or user group. For example, you cannot add and remove multiple roles for a user in the same request body.

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

• name — A string value that contains the workspace's new name.

• description — A string value that contains the new workspace description.

• type — A string value that contains the new workspace visibility [type] This property does not support the following workspace visibility changes:

  • private to public, public to private, and private to personal for Free and Basic [plans]
  • public to personal for team users only.

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.

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

• name — A string value that contains the workspace's name.

• type — A string value that contains the workspace type:

  • personal
  • private — Private workspaces are available on Qodex [Professional and Enterprise plans]
  • public
  • team
  • partner — [Partner Workspaces] are available on Qodex [Professional and Enterprise plans]

• description — (Optional) A string value that contains a description of the workspace.

Note:

This endpoint returns a 403 Forbidden response if the user does not have permission to create workspaces. [Admins and Super Admins] can configure workspace permissions to restrict users and/or user groups from creating workspaces or require approvals for the creation of team workspaces.

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.

Gets information about a workspace.

Note:

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

• personal — Only you can access the workspace.
• team — All team members can access the workspace.

• private — Only invited team members can access the workspace ([Professional and Enterprise plans only]

• public — Everyone can access the workspace.

• partner — Only invited team members and [partners] can access the workspace ([Professional and Enterprise plans only]

Important

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

• collections
• environments
• mocks
• monitors
• apis

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.

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:

• personal — Only you can access the workspace.
• team — All team members can access the workspace.

• private — Only invited team members can access the workspace ([Professional and Enterprise plans only]

• public — Everyone can access the workspace.

• partner — Only invited team members and [partners] can access the workspace ([Professional and Enterprise plans only]

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.

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

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.

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.

This endpoint is deprecated in Qodex v10 and higher.

Deletes an API version.

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.

This endpoint is deprecated in Qodex v10 and higher.

Gets an API version's monitor relations.

This endpoint is deprecated in Qodex v10 and higher.

Gets an API version's documentation relations.

This endpoint is deprecated.

This endpoint is deprecated.

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.

This endpoint is deprecated in Qodex v10 and higher.

Gets all of an API version's test relations.

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

This endpoint is deprecated in Qodex v10 and higher.

Gets an API version's environment relations.

This endpoint is deprecated.

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:

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.

This endpoint is deprecated in Qodex v10 and higher.

Gets information about an API's definition.

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.

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.

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.

This endpoint is deprecated in Qodex v10 and higher.

Gets information about an API version's release.

This endpoint is deprecated in Qodex v10 and higher.

Gets information about all of an API version's 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.

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.

This endpoint is deprecated in Qodex v10 and higher.

Deletes an API version's release.

Gets information about all 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.

Gets information about an API.

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.

Deletes an API.

This endpoint is deprecated.

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

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