openapi: 3.0.3 info: title: Postman API version: 1.47.0 description: | The Postman API enables you to programmatically access data stored in your Postman account. This includes collections, environments, workspaces, and more. Use the Postman API to integrate Postman with your development workflow and automate tasks in your CI/CD pipelines. For information about Postman, see [Postman quick start](https://learning.postman.com/docs/getting-started/quick-start/). **Note:** Certain endpoints may be unavailable depending on your region and/or Postman plan. ## Getting started ### EU users For users in the EU with [**Enterprise** plans](https://www.postman.com/pricing/), the Postman API uses the `http://api.eu.postman.com` subdomain. This is available in the definition's list of servers. You can change this by selecting the `http://api.eu.postman.com` subdomain in the **Server** dropdown list below. ## About the Postman API - You must use a valid API Key to send requests to the API endpoints. - The API has [rate and usage limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-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. - 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 Postman. The `POST` method implies you want to save something new to Postman. - For all requests, API calls respond with their corresponding [HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes). In the Postman client, the status code also provides help text that details the possible meaning of the response code. ### IDs and UIDs All items in Postman, such as collections, workspaces, and APIs, have IDs and UIDs: - An ID is the unique ID assigned to a Postman item. For example, `ec29121c-5203-409f-9e84-e83ffc10f226`. - The UID is the **full** ID of a Postman item. This value is the item's unique ID concatenated with the user ID. For example, in the `12345678-ec29121c-5203-409f-9e84-e83ffc10f226` UID, where `12345678` is the user's ID and `ec29121c-5203-409f-9e84-e83ffc10f226` is the item's ID. ### Enum values Any documented enum values should be considered partial lists and may change over time. ### 403 response for unavailable features Depending on your region and/or Postman [plan](https://www.postman.com/pricing/), some endpoints will return an HTTP `403 Forbidden` response with the "This feature isn't available in your region." detail. ### 503 response An HTTP `503 Service Unavailable` response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP `5XX` error, [contact support](https://support.postman.com/hc/en-us/requests/new/). ### Deprecated endpoints Endpoints marked as deprecated are no longer supported and may be removed in future versions of the API. They exist in the documentation for reference purposes only. ## Authentication Postman 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 Postman is accessible with your API key. You can [generate](https://learning.postman.com/docs/developer/postman-api/authentication/#generate-a-postman-api-key) a Postman API key in the [**API keys**](https://go.postman.co/settings/me/api-keys) section of your Postman account settings. You must include an API key in each request to the Postman API with the `X-API-Key` request header. In Postman, you can store your API key as a [vault secret](https://learning.postman.com/docs/sending-requests/postman-vault/postman-vault-secrets/) or an [environment variable](https://www.postman.com/docs/environments). The Postman API [collection](https://www.postman.com/docs/collections) will use it to make API calls. ### SCIM authentication While all other endpoints in this collection require a Postman API key, the SCIM endpoints require a [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key). ### Authentication error response If an API key is missing, malformed, or invalid, you will receive an HTTP `401 Unauthorized` response code. ## Rate and usage limits API access [rate limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/) apply at a per-user basis in unit time. The limit is **300 requests per minute**. - Postman Monitors, as well as the GET `/collections`, GET `/workspaces`, and GET `/workspaces/{id}` endpoints have a rate limit of **10 calls in 10 seconds**. - Workspace updates endpoints have a rate limit of **20 requests per minute per user**. - The POST `/import/openapi` endpoint has a rate limit of **10 requests in 10 seconds**. Depending on your [plan](https://www.postman.com/pricing/), you may also have [usage limits](https://learning.postman.com/docs/billing/resource-usage/). Every API response includes headers to help you identify the status of your use limits. For more information, see [Track Postman API call limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/). When you reach your rate or usage limits, the API returns the following HTTP `429 Too Many Requests` status code with one of the following error responses: - `rateLimited` — Rate limits reached. The response returns the time after which you can resume calls to the Postman API. The response header also includes the `X-RateLimit-RetryAfter` and `Retry-After` responses when you go over your limit, which returns the seconds remaining until you can make another request. - `serviceLimitExhausted` — Postman API service limits reached. You will need to contact your Postman Team Admin for assistance. ## Support For help regarding accessing the Postman API, you can: - Visit [Postman Support](https://support.postman.com/hc/en-us) or our [Community and Support](https://www.postman.com/community/) sites. - Reach out to the [Postman community](https://community.postman.com/). - Submit a help request to [Postman support](https://support.postman.com/hc/en-us/requests/new/). ## Policies - [Postman Terms of Service](http://www.postman.com/legal/terms/) - [Postman Privacy Policy](https://www.postman.com/legal/privacy-policy/) termsOfService: https://www.postman.com/legal/terms/ contact: name: Postman Support email: help@postman.com url: https://www.postman.com/community/ servers: - url: https://api.postman.com - url: https://api.eu.postman.com security: - PostmanApiKey: [] tags: - name: Access Requests description: The **Access Requests** endpoints enable you to manage Postman team access requests. - name: Activity Feed description: The **Activity Feed** endpoints enable you to get a workspace's [activity feed](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/changelog-and-restoring-collections/#view-workspace-activity). Activity feeds return information about who added or removed collections, environments, or elements from a workspace, and users that join or leave a workspace. - name: Analytics description: | The **Analytics** endpoints enable you to explore Postman's [analytics reports](https://postman.postman.co/reports/overview) programmatically. They provide visibility into usage patterns, workspace and collection activity, API performance, license distribution, and partner onboarding flow. Use these endpoints to incorporate analytics directly into your pipelines, dashboards, and internal agents. These endpoints are only available on Postman [**Enterprise**](https://www.postman.com/pricing/) plans. - name: API description: | **These endpoints are deprecated in Postman v12 and later.** In Postman v12 and later, these APIs are no longer supported. API Builder will remain available on Postman v11, but it will no longer be actively developed or supported. It's strongly recommended that if you use API Builder and upgrade to Postman v12 to migrate your APIs to [Spec Hub](https://learning.postman.com/docs/design-apis/specifications/overview) and use the Spec Hub APIs. The **API** endpoints enable you to manage your APIs. When using these endpoints, you must send an `Accept` header with the `application/vnd.api.v10+json` value. - name: API Builder to Spec Hub Migration description: These endpoints enable you to migrate your API Builder APIs to Spec Hub for Postman v12 and later. - name: API Catalog description: | The [API Catalog](https://learning.postman.com/docs/api-catalog/overview) endpoints enable you to manage your centralized APIs and services, connect your source code to the API Catalog, and automatically display all your APIs in one place. These endpoints are only available on Postman [**Enterprise**](https://www.postman.com/pricing/) plans. - name: API Governance description: The **API Governance** endpoints enable you to manage the [governance of your API](https://learning.postman.com/docs/api-catalog/governance-groups/overview/). Governance helps you to identify inconsistencies or weaknesses in your APIs and recommend possible fixes or improvements that follow industry best practices. - name: API Tags description: | **These endpoints are deprecated in Postman v12 and later.** The **API Tags** endpoints enable you to manage API tags with Postman's [tagging](https://learning.postman.com/docs/designing-and-developing-your-api/managing-apis/#tagging-apis) feature. Tagging is available on Postman [**Enterprise** plans](https://www.postman.com/pricing/). - name: API Versions description: | **These endpoints are deprecated in Postman v12 and later.** The **API Versions** endpoints enable you to manage your [API's versions](https://learning.postman.com/docs/designing-and-developing-your-api/versioning-an-api/versioning-an-api-overview/#publishing-an-api-version). Only users with the [API Admin](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#api-roles) or [Workspace Admin](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#workspace-roles) role can publish and manage versions. - name: Audit Logs description: The [**Audit Logs**](https://learning.postman.com/docs/administration/audit-logs/) endpoints enable you to monitor and analyze your Enterprise Postman teams. These endpoints are only available on Postman [**Enterprise** plans](https://www.postman.com/pricing). - name: Billing description: The **Billing** endpoints enable you to manage your Postman billing account, such as your team's plan and [billing](https://learning.postman.com/docs/billing/billing/) information. - name: Collection Access Keys description: | The **Collection Access Keys** endpoints enable you to manage your [collection access keys](https://learning.postman.com/docs/developer/postman-api/authentication/#generate-a-collection-access-key). Collection access keys enable you to securely grant other users read-only access to a collection. Collection access keys are valid for 60 days. If unused, the access key expires after 60 days. If someone uses the access key, then its expiration date increases by another 60 days. - name: Collections description: The **Collections** endpoints enable you to manage your Postman [Collections](https://learning.postman.com/docs/sending-requests/intro-to-collections/). - name: Collection Items description: The **Collection Items** endpoints enable you to manage a collection's items, such as folders and requests. - name: Collection Requests description: The **Collection Requests** endpoints enable you to manage collection requests. - name: Collection Folders description: The **Collection Folders** endpoints enable you to manage collection folders. - name: Collection Responses description: The **Collection Responses** endpoints enable you to manage collection responses. - name: Collection Tags description: The **Collection Tags** endpoints enable you to manage collection tags with Postman's [tagging](https://learning.postman.com/docs/collections/using-collections/#tagging-a-collection) feature. Tagging is available on Postman [**Enterprise** plans](https://www.postman.com/pricing/). - name: Collection to API description: The **Collection to API** endpoints enable you to transform your Postman Collections into API definitions. - name: Comments description: The **Comments** endpoints enable you to manage comments on an element. You can use [comments](https://learning.postman.com/docs/collaborating-in-postman/working-with-your-team/discussing-your-work/) to collaborate and discuss your work with your teammates in Postman. - name: Components description: | The **Components** endpoints enable you to manage components in the Postman [Component Library](https://learning.postman.com/docs/design-apis/specifications/component-library). Maintain and standardize your team's commonly used components, without having to redefine them in each specification. Reusable components can include schemas, responses, parameters, and more. The Postman Component Library is available with [Postman Enterprise plans](https://www.postman.com/pricing/). - name: Component Versions description: These endpoints enable you to manage component versions. Versioning component files is useful for publishing a new version of your reusable components, while still supporting earlier versions. - name: Component Drafts description: | These endpoints enable you to manage your component file drafts. **Note:** You can't reuse components in a draft component file. You must publish a component file to enable your teammates to reference its components in their specifications. - name: Context Graph description: | The **Context Graph** endpoints enable you to ask natural-language questions about your team's software estate and get a grounded answer along with the graph data it rests on. These endpoints are asynchronous. Submit an ask, then poll it for its status and result. - name: Custom Functions description: These endpoints enable you to manage [custom Spectral functions](https://learning.postman.com/docs/api-governance/configurable-rules/spectral#spectral-custom-functions) used by any ruleset. Use functions to enforce checks that aren't covered by the standard rule types or that are custom to your team's needs. - name: Detected Secrets description: The **Detected Secrets** endpoints enable you to manage secrets detected by the Postman [Secret Scanner](https://learning.postman.com/docs/administration/secret-scanner/). - name: Discovery Services description: These endpoints enable you to manage your API Catalog's [discovered services](https://learning.postman.com/docs/api-catalog/overview#discover-apis-and-services) and integrate them with Postman. - name: Documentation description: | The **Documentation** endpoints enable you to manage your [published documentation](https://learning.postman.com/docs/publishing-your-api/publishing-your-docs/). To publish documentation, it must be part of a collection. Publishing your documentation makes it publicly available to anyone with the link to the documentation. **Note:** Your [Postman plan](https://www.postman.com/pricing/) impacts your use of these endpoints: - For **Free** and **Solo** users, you must have permissions to edit the collection. - If [API Security and Governance](https://learning.postman.com/docs/api-governance/configurable-rules/configurable-rules-overview/) is enabled for your [**Enterprise**](https://www.postman.com/pricing/) team, only users with the [Community Manager role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) can publish documentation. - name: Environments description: The **Environments** endpoints enable you to manage your Postman [environments](https://learning.postman.com/docs/sending-requests/managing-environments/). - name: Forks description: The **Forks** endpoints enable you to manage element [forks](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/). Forks are new instances of an element that you can change without making any changes to the parent element. - name: Generated Specs description: These endpoints enable you to manage your generated API specifications. - name: Global Variables description: The **Global Variables** endpoints enable you to manage global [variables](https://learning.postman.com/docs/sending-requests/variables/). Global variables are available throughout a workspace and have the broadest scope in Postman. - name: Governance Groups description: These endpoints enable you to manage your team's [governance groups](https://learning.postman.com/docs/api-catalog/governance-groups/governance-groups) and their workspace assignments. - name: Group Provisioning description: The **Group Provisioning** endpoints enable you to provision and manage your Postman groups. - name: Groups description: The **Groups** endpoints enable you to manage user [groups](https://learning.postman.com/docs/collaborating-in-postman/user-groups/) in Postman. With groups, you can arrange users into groups that reflect your organizational structure. - name: Import description: The **Import** endpoints enable you to manage [importing and exporting](https://learning.postman.com/docs/getting-started/importing-and-exporting-data/) Postman data. - name: Mocks description: The **Mocks** endpoints enable you to manage your [mock servers](https://learning.postman.com/docs/designing-and-developing-your-api/mocking-data/setting-up-mock/). - name: Monitors description: The **Monitors** endpoints enable you to manage your [monitors](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/). - name: OAuth 2.0 description: | The **OAuth** endpoints enable you to manage your [OAuth 2.0 tokens](https://learning.postman.com/docs/sending-requests/authorization/oauth-20/) in Postman. **Note:** These endpoints use Basic Auth. You must pass a valid client ID and client secret for the username and password, respectively. - name: Packages description: The **Packages** endpoints enable you to manage your team's [Postman Package Library](https://learning.postman.com/docs/tests-and-scripts/write-scripts/packages/package-library). The package library lets you store and share your team's commonly used scripts as reusable packages in Postman. - name: Partner Workspaces description: These endpoints enable you to manage your [Partner Workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/overview/). Partner Workspaces help partners consume your team's APIs and work together on API projects. - name: Postbot description: | **These endpoints are deprecated in Postman v12 and later.** The [**Postbot**](https://learning.postman.com/docs/getting-started/basics/about-postbot/) endpoints enable you to programmatically engage with Postman's AI assistant. - name: Pull Requests description: These endpoints enable you to manage your [pull requests](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/creating-pull-requests/) in Postman. Pull requests allow reviewers to look at your changes. Reviewers can make comments on your changes and will decide whether to approve them and merge them into the parent element. - name: Private API Network description: The **Private API Network** endpoints enable you to manage and work with your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). These endpoints are only available on Postman [**Enterprise** plans](https://www.postman.com/pricing/#enterprise-solutions). - name: Roles description: The **Roles** endpoints enable you to manage user roles. [Roles])(https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/) define user permissions within a Postman workspace. - name: Runners description: | The **Runners** endpoints manage [Runners](http://learning.postman.com/docs/monitoring-your-api/runners/overview/). Runners enable you to monitor and test your organization's APIs from your internal network, without publicly exposing your endpoints. **Note:** These endpoints are only available for users who have the **Runner Management** feature enabled. To get access, contact your Customer Success Manager. - name: Runner Instances description: These endpoints manage runner instances. Instances are runner executions that share the same runner ID and key. - name: Runner Metrics description: These endpoints manage runner metrics. Metrics include information such as monitor run queues and last polling date. - name: Rulesets description: These endpoints enable you to manage your team's [governance rulesets](https://learning.postman.com/docs/api-catalog/governance-groups/ruleset-library). Rulesets are sets of governance rules that validate your OpenAPI specifications against your custom standards. - name: Schema description: | **These endpoints are deprecated in Postman v12 and later.** The **Schema** endpoints enable you to manage your API definitions. These endpoints also support multi-file schema. - name: SCIM description: | Postman supports [SCIM](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/) (System for Cross-domain Identity Management), which allows you to automate your team's provisioning. You can deploy Postman at scale across your organization and control access to it with your identity provider. SCIM provisioning is only available with a Postman [**Enterprise** plan](https://www.postman.com/pricing). **Note:** - While all other endpoints in this collection require a Postman API key, **these endpoints require a [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key)**. - You must be a [Team Admin](http://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) to enable SCIM. - To use SCIM, you must have only **one** SSO method configured. If you have more than one SSO method enabled, you cannot generate an SCIM API key. - You can only deactivate users with the SCIM API. You cannot permanently delete users with the API. - You must [configure SSO](https://learning.postman.com/docs/administration/sso/admin-sso/) and [enable SCIM](http://learning.postman.com/docs/administration/managing-your-team/configuring-scim/#enabling-scim-provisioning) for your Postman team to use these endpoints. ### Rate limits For your organization's team, Postman applies per-minute rate limits across all SCIM API endpoints. This helps ensure that you have the best experience using Postman's SCIM API. The rate limits apply as follows: - **Write (POST, PUT, PATCH)** — 180 requests per minute. - **Read (GET)** — 300 requests per minute. If you reach the rate limit, the API will return an HTTP `429 Too Many Requests` response. - name: SDKs description: | The [**SDKs**](https://learning.postman.com/docs/sdk-generator/overview) endpoints turn Postman Collections and specifications into client SDKs for TypeScript, Python, Java, Kotlin, C#, Go, PHP, Ruby, and Rust. It generates type-safe libraries with automatic methods, inferred types, and API documentation. These endpoints are only available on Postman [**Team** and **Enterprise**](https://www.postman.com/pricing/) plans. The automatic pull request update feature is only available to **Enterprise** plan users. - name: SDK Git Connections description: | These endpoints manage Git repository connections and pull requests that ship SDK updates. **Note:** The automatic pull request update feature is only available to **Enterprise** plan users. If the user is on a **Team** plan, this value is always `false`. - name: Search description: The **Search** endpoints enable you to search for Postman elements, such as workspaces, collections, specifications, and other resources. - name: Secret Scanner description: The **Secret Scanner** endpoints enable you to manage the secrets detected by Postman's [Secret Scanner](https://learning.postman.com/docs/administration/secret-scanner/). These endpoints are only available on [**Enterprise** plans](https://www.postman.com/pricing/#enterprise-solutions) with the **Advanced Security Administration** add-on feature. - name: Specs description: | The **Specs** endpoints enable you to manage your API specifications. With Postman's [Spec Hub](https://learning.postman.com/docs/design-apis/specifications/overview/), you can [create](https://learning.postman.com/docs/design-apis/specifications/create-a-specification/) or [import](https://learning.postman.com/docs/design-apis/specifications/import-a-specification/) your API specifications. You can also [generate collections](https://learning.postman.com/docs/design-apis/specifications/generate-collections/) from or for your API specifications. **Note:** Postman supports OpenAPI 2.0, 3.0, and 3.1 specifications, AsyncAPI 2.0 and 3.0 specifications, protobuf 2 and protobuf 3 specifications, GraphQL specifications, and Smithy 2.0 specifications. - name: Services description: These endpoints enable you to retrieve and monitor [services](https://learning.postman.com/docs/api-catalog/explore/) in your API Catalog. Services map to a Postman workspace and aggregates traffic analytics, compliance signals (monitor runs, CI pipeline runs, spec lints), endpoint performance, and governance metadata. - name: Spec Files description: | The **Spec Files** endpoints enable you to manage your API specification's files. **Note:** - Multi-file specifications are supported for OpenAPI 2.0, 3.0, and 3.1 specifications and protobuf 2 and 3 specifications. - Files cannot exceed a maximum of 10 MB in size. - name: Spec Collections description: These endpoints enable you to manage [collections](https://learning.postman.com/docs/design-apis/specifications/generate-collections/) generated from your API specification. Postman automatically creates collections with folders, requests, and response examples based on the specification. - name: System Environments description: These endpoints enable you to manage your team's [system environments](https://learning.postman.com/docs/api-catalog/overview#system-environments). System environments let you define organization-wide deployment stages (such as production, staging, or QA) and associate workspace-level Postman environments with them. - name: Teams description: | The **Teams** endpoints enable you to manage your [organization](https://learning.postman.com/docs/administration/managing-your-team/overview)'s teams. **Note:** - These endpoints are only available with [Postman **Enterprise** plans](https://www.postman.com/pricing/ with [Postman Organizations](https://learning.postman.com/docs/administration/onboarding-checklist) enabled. - You must have the [Super Admin team role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) to use these endpoints. - Use the `identifierType=scim` header in these requests (except the **Team Settings** endpoints) to use SCIM user and group IDs instead of Postman user IDs. - name: Team Settings description: These endpoints enable you to manage your Postman team's settings. - name: Team Roles description: These endpoints enable you to manage your Postman team's roles. - name: Tags description: The **Tags** endpoints enable you to manage Postman's tagging feature. Tagging is available on Postman [**Solo**, **Team**, and **Enterprise** plans](https://www.postman.com/pricing/). - name: Transfer Collection Items description: The **Transfer Collection Items** endpoints enable you to move collection items between different collections or folders. - name: Users description: The **Users** endpoints enable you to get information about Postman users on your team. - name: User Provisioning description: | The **User Provisioning** endpoints enable you to provision and manage your Postman users. - You can only deactivate users with the SCIM API. You cannot permanently delete users with the API. - Users created with the SCIM API are automatically created in Postman: - If the account's email ID does not exist, the user is also added to their organization's Postman team. - If the account's email ID already exists, the system sends the user an email invite to join the Postman team. After they accept the invite, the are added to the team. - If the user's email domain matches your team's verified domains, the user is immediately added to the team. - By default, new users are given the developer role in Postman. Postman user roles cannot be updated via the SCIM API. You must manage user and group roles in Postman. - name: Version Tags description: These endpoints enables you to manage your specifications' version tags. Version tags are snapshots of a specification at a point in time that let you to track changes to your specifications over time. - name: Workspaces description: The **Workspaces** endpoints enable you to manage your [workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/). The Workspaces endpoints let you manage your workspaces. Workspaces enable you to organize your Postman work and collaborate with teammates. - name: Workspace Tags description: The **Workspace Tags** endpoints enable you to manage workspace tags with Postman's [tagging](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#tagging-a-workspace) feature. Tagging is available on Postman [**Enterprise** plans](https://www.postman.com/pricing/). - name: Workspace Updates description: | These endpoints enable you to manage your [workspace updates](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/workspace-updates/). Workspace updates keep your team and your users aware of your API changes. Note: - These endpoints have a rate limit of 20 requests per minute per user. - Workspace updates are only available in team and public workspaces. Only users with the [Workspace Admin or Workspace Editor](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#workspace-roles) role can post and edit workspace updates. - name: Webhooks description: The **Webhooks** endpoints enable you to manage [custom webhooks](https://learning.postman.com/docs/running-collections/collection-webhooks/). paths: /accounts: get: summary: Get accounts description: Gets Postman billing account details for the given team. operationId: getAccounts tags: - Billing responses: '200': $ref: '#/components/responses/getAccounts' '400': $ref: '#/components/responses/invoices400Error' '401': $ref: '#/components/responses/common401Error' '500': $ref: '#/components/responses/common500Error' /accounts/{accountId}/invoices: get: summary: List account invoices description: Gets all invoices for a Postman billing account filtered by the status of the invoice. operationId: getAccountInvoices tags: - Billing responses: '200': $ref: '#/components/responses/getAccountInvoices' '400': $ref: '#/components/responses/invoices400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/invoices403Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/billingAccountId' - $ref: '#/components/parameters/billingAccountStatus' /analytics: get: summary: Get analytics data description: | Gets analytics data based on the specified resource, metrics, and given filters for team, internal, and public workspaces, as well as Partner Workspaces. **Note:** This endpoint only accepts the following resource:metric query parameter combinations: - `user` — `workspace_active_users`, `active_users` - `workspace` — `elements_in_workspace`, `active_workspaces`, `api_calls`, `active_collections`, `response_status`, `pending_invites`, `needs_attention`, `success_rate`, `user_requests`, `collection_error_aggregate` - `team` — `user_api_journey`, `workspace_distribution`, `internal_workspace_distribution`, `license_consumption`, `members`, `last_autoflex_cycle`, `partner_engagement_funnel` `members_overtime` , `member_invites`, `invites_sent` , `invites_accepted` - `ai` — `top_agent_models_by_usage`, `activity_distribution`, `peak_activity`, `usage_leaderboard`, `credit_usage_by_model`, `messages_sent`, `credit_usage`, `agent_mode_sessions`, `new_vs_returning_users`, `agent_mode_users` - `api_development` — `active_workspaces`, `entity_activity`, `top_entities` - `api_testing` — `runs`, `functional_test_runs`, `performance_test_runs` - `api_production` — `monitor_runs`, `flow_executions` - `api_distribution` — `active_workspaces`, `pvt_network`, `partner`, `public` - `api_management` — `workspace_activity` The `view` query parameter only accepts the following values when called with the following resource:metric pairs: `detailed` or `summary` — `user:active_users`, `workspace:active_workspaces`, `workspace:pending_invites`, `workspace:needs_attention`, `workspace:success_rate`, `team:partner_engagement_funnel`, `api_distribution:pvt_network`, `api_distribution:partner`, `api_distribution:public` - `detailed`, `summary`, or `trends` — `api_development:entity_activity`, `api_testing:functional_test_runs` , `api_testing:performance_test_runs`, `api_production:monitor_runs`, `api_production:flow_executions` - `summary` or `trend` — `api_development:active_workspaces`, `api_testing:runs`, `api_distribution:active_workspaces`, `api_management:workspace_activity` - `summary` only — `workspace:elements_in_workspace`, `workspace:workspace_active_users`, `workspace:api_calls`, `workspace:response_status`, `team:user_api_journey`, `team:workspace_distribution`, `team:internal_workspace_distribution`, `team:license_consumption` - `detailed` only — `workspace:active_collections`, `workspace:user_requests`, `api_development:top_entities`, `api_management:popular_workspaces` , `team:invites_sent` , `team:invites_accepted` - `trend` only — `team:members_overtime`, `team:member_invites` operationId: getAnalyticsData x-postman-plan: Enterprise tags: - Analytics parameters: - $ref: '#/components/parameters/analyticsResource' - $ref: '#/components/parameters/analyticsMetrics' - $ref: '#/components/parameters/analyticsView' - $ref: '#/components/parameters/analyticsWorkspaceType' - $ref: '#/components/parameters/analyticsUserId' - $ref: '#/components/parameters/analyticsDuration' - $ref: '#/components/parameters/analyticsRequestId' - $ref: '#/components/parameters/analyticsResponseStatus' - $ref: '#/components/parameters/analyticsAttentionType' - $ref: '#/components/parameters/analyticsPeriod' - $ref: '#/components/parameters/analyticsUserType' - $ref: '#/components/parameters/analyticsEntityType' - $ref: '#/components/parameters/limitDefault100Max10000' - $ref: '#/components/parameters/offsetMax10000' responses: '200': $ref: '#/components/responses/getAnalyticsData' '400': $ref: '#/components/responses/analytics400Error' '401': $ref: '#/components/responses/analytics401Error' '403': $ref: '#/components/responses/analytics403Error' '500': $ref: '#/components/responses/common500Error' /analytics-metadata: get: summary: Get analytics metadata description: Returns a catalog of analytics resources and their corresponding metrics for use with the GET /analytics endpoint. These metrics provide insights on API usage, success, workspace, and team trends in Postman. operationId: getAnalyticsMetadata tags: - Analytics parameters: - $ref: '#/components/parameters/analyticsMetadataInclude' - $ref: '#/components/parameters/analyticsMetadataResources' - $ref: '#/components/parameters/analyticsMetadataMetrics' responses: '200': $ref: '#/components/responses/getAnalyticsMetadata' '401': $ref: '#/components/responses/analytics401Error' '403': $ref: '#/components/responses/analytics403Error' '500': $ref: '#/components/responses/common500Error' /api-catalog/discovery-services: get: summary: Get discovered services description: Gets a list of all [discovered services](https://learning.postman.com/docs/api-catalog/overview#discover-apis-and-services) in the API Catalog. operationId: getApiCatalogDiscoveryServices tags: - API Catalog - Discovery Services x-postman-plan: Enterprise parameters: - $ref: '#/components/parameters/discoveryServicesSource' - $ref: '#/components/parameters/discoveryServicesStatus' - $ref: '#/components/parameters/discoveryServicesSearch' - $ref: '#/components/parameters/limitDefault20' - $ref: '#/components/parameters/cursor' responses: '200': $ref: '#/components/responses/getApiCatalogDiscoveryServices' '400': $ref: '#/components/responses/getApiCatalogDiscoveryServices400Error' '401': $ref: '#/components/responses/apiCatalog401Error' '403': $ref: '#/components/responses/apiCatalog403Error' '500': $ref: '#/components/responses/common500Error' post: summary: Add discovered services to the API Catalog description: Adds discovered services to the API Catalog. Accepts up to 20 services in a single call. operationId: postApiCatalogDiscoveryServices tags: - API Catalog - Discovery Services x-postman-plan: Enterprise requestBody: $ref: '#/components/requestBodies/postApiCatalogDiscoveryServices' responses: '200': $ref: '#/components/responses/postApiCatalogDiscoveryServicesResponse' '400': $ref: '#/components/responses/postApiCatalogDiscoveryServices400Error' '401': $ref: '#/components/responses/apiCatalog401Error' '403': $ref: '#/components/responses/apiCatalog403Error' '500': $ref: '#/components/responses/common500Error' /api-catalog/discovery-services/{serviceId}: get: summary: Get a discovered service's information description: Gets detailed information about a discovered service, including a base64-encoded OpenAPI specification and an array of endpoints. operationId: getApiCatalogDiscoveryService tags: - API Catalog - Discovery Services x-postman-plan: Enterprise responses: '200': $ref: '#/components/responses/getApiCatalogDiscoveryService' '401': $ref: '#/components/responses/apiCatalog401Error' '403': $ref: '#/components/responses/apiCatalog403Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/discoveryServiceId' /api-catalog/services: get: summary: Get all services description: Gets a list of services in a system environment. The response includes details about analytics, compliance, and governance metadata. operationId: getApiCatalogServices tags: - API Catalog - Services x-postman-plan: Enterprise parameters: - $ref: '#/components/parameters/apiCatalogServiceSystemEnvironmentId' - $ref: '#/components/parameters/apiCatalogServiceNameFilter' - $ref: '#/components/parameters/apiCatalogServiceTagsFilter' - $ref: '#/components/parameters/apiCatalogServiceGovernanceGroupIdFilter' - $ref: '#/components/parameters/limitDefault20' - $ref: '#/components/parameters/cursor' responses: '200': $ref: '#/components/responses/getApiCatalogServices' '400': $ref: '#/components/responses/getApiCatalogService400Error' '401': $ref: '#/components/responses/apiCatalog401Error' '403': $ref: '#/components/responses/apiCatalog403Error' '500': $ref: '#/components/responses/common500Error' /api-catalog/services/{serviceId}: get: summary: Get a service by ID description: Gets information about a service, including its health, traffic, compliance, ownership, and dependencies. operationId: getApiCatalogService tags: - API Catalog - Services x-postman-plan: Enterprise parameters: - $ref: '#/components/parameters/apiCatalogServiceSystemEnvironmentId' responses: '200': $ref: '#/components/responses/getApiCatalogService' '400': $ref: '#/components/responses/getApiCatalogService400Error' '401': $ref: '#/components/responses/apiCatalog401Error' '403': $ref: '#/components/responses/apiCatalog403Error' '404': $ref: '#/components/responses/apiCatalogService404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiCatalogServiceId' /api-catalog/services/{serviceId}/endpoints: get: summary: Get a service's endpoints description: Get a list of observed API endpoints for a service and its performance metrics. operationId: getApiCatalogServiceEndpoints tags: - API Catalog - Services x-postman-plan: Enterprise parameters: - $ref: '#/components/parameters/apiCatalogServiceSystemEnvironmentId' - $ref: '#/components/parameters/apiCatalogServiceHttpMethodFilter' - $ref: '#/components/parameters/apiCatalogServiceHostsFilter' - $ref: '#/components/parameters/apiCatalogServiceResponseCodeFilter' - $ref: '#/components/parameters/apiCatalogServiceSearchFilter' - $ref: '#/components/parameters/apiCatalogServiceSortEndpointsFilter' - $ref: '#/components/parameters/limitDefault20' - $ref: '#/components/parameters/cursor' responses: '200': $ref: '#/components/responses/getApiCatalogServiceEndpoints' '400': $ref: '#/components/responses/getApiCatalogService400Error' '401': $ref: '#/components/responses/apiCatalog401Error' '403': $ref: '#/components/responses/apiCatalog403Error' '404': $ref: '#/components/responses/apiCatalogService404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiCatalogServiceId' /api-catalog/services/{serviceId}/monitor-runs: get: summary: Get a service's monitor runs description: Gets a list of scheduled monitor runs for a service that includes summary statistics. operationId: getApiCatalogServiceMonitorRuns tags: - API Catalog - Services x-postman-plan: Enterprise parameters: - $ref: '#/components/parameters/apiCatalogServiceSystemEnvironmentId' - $ref: '#/components/parameters/apiCatalogServiceCollectionIdFilter' - $ref: '#/components/parameters/apiCatalogServiceSortMonitorRun' - $ref: '#/components/parameters/apiCatalogServiceEnvironmentIdFilter' - $ref: '#/components/parameters/apiCatalogServiceStatusFilter' - $ref: '#/components/parameters/limitDefault20' - $ref: '#/components/parameters/cursor' responses: '200': $ref: '#/components/responses/getApiCatalogServiceMonitorRuns' '400': $ref: '#/components/responses/getApiCatalogService400Error' '401': $ref: '#/components/responses/apiCatalog401Error' '403': $ref: '#/components/responses/apiCatalog403Error' '404': $ref: '#/components/responses/apiCatalogService404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiCatalogServiceId' /api-catalog/services/{serviceId}/spec-lints: get: summary: Get a service's specification lints description: Gets a list of API specification lint runs for a service that includes summary statistics and per-severity issue counts. operationId: getApiCatalogServiceSpecificationLints tags: - API Catalog - Services x-postman-plan: Enterprise parameters: - $ref: '#/components/parameters/apiCatalogServiceSpecIdFilter' - $ref: '#/components/parameters/apiCatalogServiceSpecLintSeverityFilter' - $ref: '#/components/parameters/apiCatalogServiceSpecLintStatusFilter' - $ref: '#/components/parameters/apiCatalogServiceSortSpecLintFilter' - $ref: '#/components/parameters/limitDefault20' - $ref: '#/components/parameters/cursor' responses: '200': $ref: '#/components/responses/getApiCatalogServiceSpecificationLints' '400': $ref: '#/components/responses/getApiCatalogService400Error' '401': $ref: '#/components/responses/apiCatalog401Error' '403': $ref: '#/components/responses/apiCatalog403Error' '404': $ref: '#/components/responses/apiCatalogService404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiCatalogServiceId' /api-catalog/services/{serviceId}/ci-runs: get: summary: Get a service's CI runs description: Gets a paginated list of CI collection runs for a service that includes summary statistics, pipeline details, and Git metadata. operationId: getApiCatalogServiceCiRuns tags: - API Catalog - Services x-postman-plan: Enterprise parameters: - $ref: '#/components/parameters/apiCatalogServiceSystemEnvironmentId' - $ref: '#/components/parameters/apiCatalogServiceCollectionIdFilter' - $ref: '#/components/parameters/apiCatalogServiceEnvironmentIdFilter' - $ref: '#/components/parameters/apiCatalogServiceStatusFilter' - $ref: '#/components/parameters/apiCatalogServiceBranchFilter' - $ref: '#/components/parameters/apiCatalogServiceWorkflowNameFilter' - $ref: '#/components/parameters/apiCatalogActorFilter' - $ref: '#/components/parameters/apiCatalogServiceRepoNameFilter' - $ref: '#/components/parameters/apiCatalogServiceRepoOwnerFilter' - $ref: '#/components/parameters/apiCatalogServiceSortCiFilter' - $ref: '#/components/parameters/limitDefault20' - $ref: '#/components/parameters/cursor' responses: '200': $ref: '#/components/responses/getApiCatalogServiceCiRuns' '400': $ref: '#/components/responses/getApiCatalogService400Error' '401': $ref: '#/components/responses/apiCatalog401Error' '403': $ref: '#/components/responses/apiCatalog403Error' '404': $ref: '#/components/responses/apiCatalogService404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiCatalogServiceId' /api-catalog/system-environments: get: summary: Get all system environments description: Gets all of the authenticated team's system environments. operationId: getApiCatalogSystemEnvironments tags: - API Catalog - System Environments x-postman-plan: Enterprise responses: '200': $ref: '#/components/responses/getApiCatalogSystemEnvironments' '400': $ref: '#/components/responses/apiCatalogSystemEnvironment400Error' '401': $ref: '#/components/responses/apiCatalog401Error' '403': $ref: '#/components/responses/apiCatalog403Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/systemEnvironmentProductionFilter' - $ref: '#/components/parameters/limitDefault20' - $ref: '#/components/parameters/cursor' post: summary: Create a system environment description: Creates a system environment for the authenticated team. operationId: createApiCatalogSystemEnvironment tags: - API Catalog - System Environments x-postman-plan: Enterprise requestBody: $ref: '#/components/requestBodies/createApiCatalogSystemEnvironment' responses: '201': $ref: '#/components/responses/createApiCatalogSystemEnvironmentResponse' '400': $ref: '#/components/responses/apiCatalogSystemEnvironment400Error' '401': $ref: '#/components/responses/apiCatalog401Error' '403': $ref: '#/components/responses/apiCatalog403Error' '409': $ref: '#/components/responses/apiCatalogSystemEnvironment409Error' '500': $ref: '#/components/responses/common500Error' /api-catalog/system-environments/{systemEnvironmentId}: get: summary: Get a system environment description: Gets information about a system environment. operationId: getApiCatalogSystemEnvironment tags: - API Catalog - System Environments x-postman-plan: Enterprise responses: '200': $ref: '#/components/responses/getApiCatalogSystemEnvironment' '400': $ref: '#/components/responses/apiCatalogSystemEnvironment400Error' '401': $ref: '#/components/responses/apiCatalog401Error' '403': $ref: '#/components/responses/apiCatalog403Error' '404': $ref: '#/components/responses/apiCatalogSystemEnvironment404Error' '500': $ref: '#/components/responses/common500Error' patch: summary: Update a system environment description: | Updates a system environment's information. You can update one or more fields in a single call. **Note:** If you update the name, it must be unique within the team. operationId: updateApiCatalogSystemEnvironment tags: - API Catalog - System Environments x-postman-plan: Enterprise requestBody: $ref: '#/components/requestBodies/updateApiCatalogSystemEnvironment' responses: '200': $ref: '#/components/responses/updateApiCatalogSystemEnvironmentResponse' '400': $ref: '#/components/responses/apiCatalogSystemEnvironment400Error' '401': $ref: '#/components/responses/apiCatalog401Error' '403': $ref: '#/components/responses/apiCatalog403Error' '404': $ref: '#/components/responses/apiCatalogSystemEnvironment404Error' '409': $ref: '#/components/responses/apiCatalogSystemEnvironment409Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/systemEnvironmentId' /api-catalog/system-environments/{systemEnvironmentId}/associations: get: summary: Get a system environment's associations description: Gets the workspace-environment associations for a system environment. operationId: getApiCatalogSystemEnvironmentAssociations tags: - API Catalog - System Environments x-postman-plan: Enterprise responses: '200': $ref: '#/components/responses/getApiCatalogSystemEnvironmentAssociations' '400': $ref: '#/components/responses/apiCatalogSystemEnvironment400Error' '401': $ref: '#/components/responses/apiCatalog401Error' '403': $ref: '#/components/responses/apiCatalog403Error' '404': $ref: '#/components/responses/apiCatalogSystemEnvironment404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/systemEnvironmentWorkspaceId' - $ref: '#/components/parameters/limitDefault20' - $ref: '#/components/parameters/cursor' post: summary: Add system environment associations description: Adds workspace-environment associations to a system environment. operationId: addApiCatalogSystemEnvironmentAssociations tags: - API Catalog - System Environments x-postman-plan: Enterprise requestBody: $ref: '#/components/requestBodies/addApiCatalogSystemEnvironmentAssociations' parameters: - $ref: '#/components/parameters/systemEnvironmentAllowPartial' responses: '200': $ref: '#/components/responses/addApiCatalogSystemEnvironmentAssociationsResponse' '400': $ref: '#/components/responses/apiCatalogSystemEnvironment400Error' '401': $ref: '#/components/responses/apiCatalog401Error' '403': $ref: '#/components/responses/apiCatalog403Error' '500': $ref: '#/components/responses/common500Error' delete: summary: Remove system environment associations description: Removes workspace-environment associations from a system environment. operationId: removeApiCatalogSystemEnvironmentAssociations tags: - API Catalog - System Environments x-postman-plan: Enterprise requestBody: $ref: '#/components/requestBodies/removeApiCatalogSystemEnvironmentAssociations' responses: '200': $ref: '#/components/responses/removeApiCatalogSystemEnvironmentAssociationsResponse' '400': $ref: '#/components/responses/apiCatalogSystemEnvironment400Error' '401': $ref: '#/components/responses/apiCatalog401Error' '403': $ref: '#/components/responses/apiCatalog403Error' '404': $ref: '#/components/responses/apiCatalogSystemEnvironment404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/systemEnvironmentId' /apis: get: deprecated: true summary: Get all APIs description: Gets information about all APIs in a workspace. operationId: getApis tags: - API responses: '200': $ref: '#/components/responses/getApis' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/api404Error' '422': $ref: '#/components/responses/v9Unsupported' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceIdQueryTrue' - $ref: '#/components/parameters/createdBy' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/apiDescription' - $ref: '#/components/parameters/limit' post: deprecated: true summary: Create an API description: Creates an API. operationId: createApi tags: - API requestBody: $ref: '#/components/requestBodies/createUpdateApi' responses: '200': $ref: '#/components/responses/createApi' '400': $ref: '#/components/responses/workspace400ErrorParamMissing' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/api403Error' '404': $ref: '#/components/responses/workspace404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceIdQueryTrue' - $ref: '#/components/parameters/v10Accept' /apis/{apiId}: get: deprecated: true summary: Get an API description: | 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. operationId: getApi tags: - API responses: '200': $ref: '#/components/responses/getApi' '400': $ref: '#/components/responses/v10HeaderMissing' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/api404Error' '422': $ref: '#/components/responses/v9Unsupported' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiInclude' put: deprecated: true summary: Update an API description: Updates an API. operationId: updateApi tags: - API requestBody: $ref: '#/components/requestBodies/createUpdateApi' responses: '200': $ref: '#/components/responses/updateApi' '400': $ref: '#/components/responses/v10HeaderMissing' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/api403Error' '404': $ref: '#/components/responses/api404Error' '422': $ref: '#/components/responses/v9Unsupported' '500': $ref: '#/components/responses/common500Error' delete: deprecated: true summary: Delete an API description: Deletes an API. On success, this returns an HTTP `204 No Content` response. operationId: deleteApi tags: - API responses: '204': description: No Content '400': $ref: '#/components/responses/v10HeaderMissing' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/api403Error' '404': $ref: '#/components/responses/api404Error' '422': $ref: '#/components/responses/v9Unsupported' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/v10Accept' /apis/{apiId}/collections: post: deprecated: true summary: Add a collection description: | 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 Postman's [OpenAPI to Postman Collection Converter OPTIONS documentation](https://github.com/postmanlabs/openapi-to-postman/blob/develop/OPTIONS.md). These properties are case-sensitive. operationId: addApiCollection tags: - API - Collections requestBody: $ref: '#/components/requestBodies/addApiCollection' responses: '200': $ref: '#/components/responses/addApiCollection' '400': $ref: '#/components/responses/v10HeaderMissing' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/api403Error' '404': $ref: '#/components/responses/api404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/v10Accept' /apis/{apiId}/collections/{collectionId}: get: deprecated: true summary: Get a collection description: | Gets a collection attached to an API. You can use the `versionId` query parameter to get a collection published in a version. **Note:** - You cannot use this endpoint to get a Git-linked API collection. Collections in a Git-linked API are stored in the linked Git repository, not in the Postman cloud. This endpoint only has access to Postman servers. - You can get a collection published in an API version with the `versionId` query parameter. - The `versionId` query parameter is a required parameter for API viewers. operationId: getApiCollection tags: - API - Collections responses: '200': $ref: '#/components/responses/getApiCollection' '400': $ref: '#/components/responses/api400Error' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/api403Error' '404': $ref: '#/components/responses/api404Error' '422': $ref: '#/components/responses/api422Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiVersionQuery' parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/collectionIdApi' - $ref: '#/components/parameters/v10Accept' /apis/{apiId}/collections/{collectionId}/comments: get: deprecated: true summary: Get a collection's comments description: Gets all comments left by users in an API's collection. operationId: getApiCollectionComments tags: - API - Collections - Comments responses: '200': $ref: '#/components/responses/commentGet' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' post: deprecated: true summary: Create a collection comment description: | Creates a comment on an API's collection. To create a reply on an existing comment, include the `threadId` property in the request body. **Note:** This endpoint accepts a max of 10,000 characters. operationId: createApiCollectionComment tags: - API - Collections - Comments requestBody: $ref: '#/components/requestBodies/commentCreate' responses: '201': $ref: '#/components/responses/commentCreated' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/collectionIdApi' /apis/{apiId}/collections/{collectionId}/comments/{commentId}: put: deprecated: true summary: Update a collection's comment description: | Updates a comment on an API's collection. **Note:** This endpoint accepts a max of 10,000 characters. operationId: updateApiCollectionComment tags: - API - Collections - Comments requestBody: $ref: '#/components/requestBodies/commentUpdate' responses: '200': $ref: '#/components/responses/commentUpdated' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' delete: deprecated: true summary: Delete a collection's comment description: | Deletes a comment from an API's 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. operationId: deleteApiCollectionComment tags: - API - Collections - Comments responses: '204': description: No Content '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/collectionIdApi' - $ref: '#/components/parameters/commentId' /apis/{apiId}/collections/{collectionId}/sync-with-schema-tasks: put: deprecated: true summary: Sync collection with schema description: | 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. operationId: syncCollectionWithSchema tags: - API - Collections responses: '202': $ref: '#/components/responses/syncCollectionWithSchema' '400': $ref: '#/components/responses/api400Error' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/api403Error' '404': $ref: '#/components/responses/api404Error' '422': $ref: '#/components/responses/api422Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/collectionIdApi' - $ref: '#/components/parameters/v10Accept' /apis/{apiId}/comments: get: deprecated: true summary: Get an API's comments description: Gets all comments left by users in an API. operationId: getApiComments tags: - API - Comments responses: '200': $ref: '#/components/responses/commentGet' '400': $ref: '#/components/responses/v10HeaderMissing' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403ErrorAndFeatureUnavailable' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' post: deprecated: true summary: Create an API comment description: | Creates a comment on an API. To create a reply on an existing comment, include the `threadId` property in the request body. **Note:** This endpoint accepts a max of 10,000 characters. operationId: createApiComment tags: - API - Comments requestBody: $ref: '#/components/requestBodies/commentCreate' responses: '201': $ref: '#/components/responses/commentCreated' '400': $ref: '#/components/responses/v10HeaderMissing' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403ErrorAndFeatureUnavailable' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' parameters: - $ref: '#/components/parameters/apiId' /apis/{apiId}/comments/{commentId}: put: deprecated: true summary: Update an API's comment description: | Updates a comment on an API. **Note:** This endpoint accepts a max of 10,000 characters. operationId: updateApiComment tags: - API - Comments requestBody: $ref: '#/components/requestBodies/commentUpdate' responses: '200': $ref: '#/components/responses/commentUpdated' '400': $ref: '#/components/responses/v10HeaderMissing' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403ErrorAndFeatureUnavailable' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' delete: deprecated: true summary: Delete an API's comment description: | 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. operationId: deleteApiComment tags: - API - Comments responses: '204': description: No Content '400': $ref: '#/components/responses/v10HeaderMissing' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403ErrorAndFeatureUnavailable' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/commentId' /apis/{apiId}/schemas: post: deprecated: true summary: Create a schema description: Creates a schema for an API. operationId: createApiSchema tags: - API - Schema requestBody: $ref: '#/components/requestBodies/createApiSchema' responses: '200': $ref: '#/components/responses/createApiSchema' '400': $ref: '#/components/responses/api400Error' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/api403Error' '404': $ref: '#/components/responses/api404Error' '422': $ref: '#/components/responses/api422Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/v10Accept' /apis/{apiId}/schemas/{schemaId}: get: deprecated: true summary: Get a schema description: | 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. operationId: getApiSchema tags: - API - Schema responses: '200': $ref: '#/components/responses/getApiSchema' '400': $ref: '#/components/responses/api400Error' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/api403Error' '404': $ref: '#/components/responses/api404Error' '422': $ref: '#/components/responses/api422Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiVersionQuery' - $ref: '#/components/parameters/apiSchemaOutput' parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/apiSchemaId' - $ref: '#/components/parameters/v10Accept' /apis/{apiId}/schemas/{schemaId}/files: get: deprecated: true summary: Get schema files description: | 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. operationId: getApiSchemaFiles tags: - API - Schema responses: '200': $ref: '#/components/responses/getApiSchemaFiles' '400': $ref: '#/components/responses/api400Error' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/api404Error' '422': $ref: '#/components/responses/api422Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiVersionQuery' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/apiSchemaId' - $ref: '#/components/parameters/v10Accept' /apis/{apiId}/schemas/{schemaId}/files/{file-path}: get: deprecated: true summary: Get schema file contents description: | 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. operationId: getApiSchemaFileContents tags: - API - Schema responses: '200': $ref: '#/components/responses/getApiSchemaFileContents' '400': $ref: '#/components/responses/api400Error' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/api404Error' '422': $ref: '#/components/responses/api422Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiVersionQuery' put: deprecated: true summary: Create or update a schema file description: | Creates or updates an API schema file. **Note:** - If the provided file path exists, the file is updated with the new contents. - If the provided file path does not exist, then a new schema file is 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. operationId: createUpdateApiSchemaFile tags: - API - Schema requestBody: $ref: '#/components/requestBodies/createUpdateApiSchemaFile' responses: '200': $ref: '#/components/responses/createUpdateApiSchemaFile' '400': $ref: '#/components/responses/api400Error' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/api403Error' '404': $ref: '#/components/responses/api404Error' '422': $ref: '#/components/responses/api422Error' '500': $ref: '#/components/responses/common500Error' delete: deprecated: true summary: Delete a schema file description: Deletes a file in an API schema. On success, this returns an HTTP `204 No Content` response. operationId: deleteApiSchemaFile tags: - API - Schema responses: '204': description: Deleted '400': $ref: '#/components/responses/api400Error' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/api403Error' '404': $ref: '#/components/responses/api404Error' '422': $ref: '#/components/responses/api422Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/apiSchemaId' - $ref: '#/components/parameters/file-path' - $ref: '#/components/parameters/v10Accept' /apis/{apiId}/spec-migrations: get: summary: Get status of API Builder to Spec Hub migration description: Returns the status of an API Builder definition's migration to Spec Hub. operationId: getMigrationStatus tags: - Specs - API Builder to Spec Hub Migration responses: '200': $ref: '#/components/responses/getMigrationStatus' '400': $ref: '#/components/responses/getMigrationStatus400Error' '401': $ref: '#/components/responses/migrateApiToSpecHub401Error' '403': $ref: '#/components/responses/apiSpec403Error' '500': $ref: '#/components/responses/common500Error' post: summary: Migrate API Builder API to Spec Hub description: | Migrates an API Builder definition to a [Spec Hub](https://learning.postman.com/docs/design-apis/specifications/overview) specification. You can migrate the definition to an existing workspace, or create a new workspace to migrate the definition into. On success, this returns an HTTP `202 Created` response. You can use the GET `/apis/{apiId}/spec-migrations` endpoint to check the migration status. **Note:** - This returns an HTTP `200 OK` response if the given API ID isn't an API Builder definition. - To migrate a Git-linked API Builder definition to Spec Hub, you must create a new workspace. Migration to an existing workspace isn't supported. operationId: migrateApiToSpecHub tags: - Specs - API Builder to Spec Hub Migration requestBody: $ref: '#/components/requestBodies/migrateApiToSpecHub' responses: '200': $ref: '#/components/responses/migrateApiToSpecHub200Response' '202': $ref: '#/components/responses/migrateApiToSpecHub202Response' '400': $ref: '#/components/responses/migrateApiToSpecHub400Error' '401': $ref: '#/components/responses/migrateApiToSpecHub401Error' '403': $ref: '#/components/responses/apiSpec403Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/v10Accept' /apis/{apiId}/tags: get: deprecated: true summary: Get an API's tags description: Gets all the tags associated with an API. operationId: getApiTags tags: - Tags - API Tags responses: '200': $ref: '#/components/responses/tagGetPut' '400': $ref: '#/components/responses/v10HeaderMissing' '401': $ref: '#/components/responses/tag401Error' '403': $ref: '#/components/responses/apiTags403Error' '404': $ref: '#/components/responses/tag404Error' '500': $ref: '#/components/responses/tag500Error' put: deprecated: true summary: Update an API's tags description: Updates an API's associated tags. This endpoint replaces all existing tags with those you pass in the request body. operationId: updateApiTags tags: - Tags - API Tags requestBody: $ref: '#/components/requestBodies/tagUpdateTags' responses: '200': $ref: '#/components/responses/tagGetPut' '400': $ref: '#/components/responses/apiTag400Error' '401': $ref: '#/components/responses/tag401Error' '403': $ref: '#/components/responses/apiTags403Error' '404': $ref: '#/components/responses/tag404Error' '500': $ref: '#/components/responses/tag500Error' parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/v10Accept' /apis/{apiId}/tasks/{taskId}: get: deprecated: true summary: Get status of an asynchronous task description: Gets the status of an asynchronous task. operationId: getStatusOfAnAsyncApiTask tags: - API responses: '200': $ref: '#/components/responses/getStatusOfAnAsyncApiTask' '400': $ref: '#/components/responses/api400Error' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/api403Error' '404': $ref: '#/components/responses/taskNotFound' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/apiTaskId' - $ref: '#/components/parameters/v10Accept' /apis/{apiId}/versions: get: deprecated: true summary: Get all versions description: Gets all the published versions of an API. operationId: getApiVersions tags: - API - API Versions responses: '200': $ref: '#/components/responses/getApiVersions' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/api404Error' '422': $ref: '#/components/responses/v9Unsupported' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' post: deprecated: true summary: Create a version description: | 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 Postman app, which is the snapshot of API collections and schema at a given point in time. operationId: createApiVersion tags: - API - API Versions requestBody: $ref: '#/components/requestBodies/createApiVersion' responses: '202': $ref: '#/components/responses/createApiVersion' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/api403Error' '404': $ref: '#/components/responses/api404Error' '422': $ref: '#/components/responses/api422Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/v10Accept' /apis/{apiId}/versions/{versionId}: get: deprecated: true summary: Get a version description: | 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. operationId: getApiVersion tags: - API responses: '200': $ref: '#/components/responses/getApiVersion' '302': $ref: '#/components/responses/apiVersion302StatusPending' '400': $ref: '#/components/responses/v10HeaderMissing' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/api404Error' '500': $ref: '#/components/responses/common500Error' put: deprecated: true summary: Update a version description: | Updates an API version. **Note:** This endpoint returns an HTTP `404 Not Found` response when an API version is pending publication. operationId: updateApiVersion tags: - API - API Versions requestBody: $ref: '#/components/requestBodies/updateApiVersion' responses: '200': $ref: '#/components/responses/updateApiVersion' '400': $ref: '#/components/responses/v10HeaderMissing' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/api403Error' '404': $ref: '#/components/responses/api404Error' '500': $ref: '#/components/responses/common500Error' delete: deprecated: true summary: Delete a version description: | Deletes an API version. On success, this returns an HTTP `204 No Content` response. **Note:** This endpoint returns an HTTP `404 Not Found` response when an API version is pending publication. operationId: deleteApiVersion tags: - API - API Versions responses: '204': description: No Content '400': $ref: '#/components/responses/api400Error' '401': $ref: '#/components/responses/api401Error' '403': $ref: '#/components/responses/api403Error' '404': $ref: '#/components/responses/api404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/apiId' - $ref: '#/components/parameters/apiVersionId' - $ref: '#/components/parameters/v10Accept' /audit/logs: get: summary: Get team audit logs description: Gets a list of your team's generated audit events. For a complete list of all audit events, see [Audit logs](https://learning.postman.com/docs/administration/audit-logs/). operationId: getAuditLogs x-postman-plan: Enterprise tags: - Audit Logs responses: '200': $ref: '#/components/responses/getAuditLogs' '400': $ref: '#/components/responses/auditLogs400Error' '401': $ref: '#/components/responses/common401Error' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/auditLogsUserIdQuery' - $ref: '#/components/parameters/auditLogsActionQuery' - $ref: '#/components/parameters/auditLogsSinceQuery' - $ref: '#/components/parameters/auditLogsUntilQuery' - $ref: '#/components/parameters/auditLogsLimitQuery' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/auditLogsOrderBy' - $ref: '#/components/parameters/auditLogsOrderByDeprecated' /audit-actions: get: summary: Get all audit log event actions description: Gets a complete list of all available audit log event actions. operationId: getAuditLogEventActions tags: - Audit Logs x-postman-plan: Enterprise responses: '200': $ref: '#/components/responses/getAuditLogEventActions' '400': $ref: '#/components/responses/auditLogs400Error' '403': $ref: '#/components/responses/auditLogs403Error' '500': $ref: '#/components/responses/common500Error' /collection-access-keys: get: summary: Get collection access keys description: | Gets the authenticated user's personal and team [collection access keys](https://learning.postman.com/docs/developer/postman-api/authentication/#generate-a-collection-access-key). **Note:** - The `expiresAfter` property in the response represents the date and time at which the access key expires. Collection access keys are valid for 60 days. If unused, the access key expires after 60 days. If someone uses the access key, then its expiration date increases by another 60 days. - If the collection key is unused, the `lastUsedAt` property in the response returns an empty string. operationId: getCollectionAccessKeys tags: - Collection Access Keys - Collections responses: '200': $ref: '#/components/responses/getCollectionAccessKeys' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionUidQuery' - $ref: '#/components/parameters/cursor' /collection-access-keys/{keyId}: delete: summary: Delete a collection access key description: | Deletes a collection access key. To get a collection access key's ID, use the GET `/collection-access-key` endpoint. On success, this returns an HTTP `204 No Content` response. operationId: deleteCollectionAccessKey tags: - Collection Access Keys - Collections responses: '204': description: No Content '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/cakNotFound404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionAccessKeyId' /collection-merges: put: summary: Merge or pull changes into a collection fork description: | [Merges](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/#merge-changes-from-a-fork) a forked (source) collection and its parent (destination) collection asynchronously. To pull changes into a fork, pass the forked collection's ID as the `destination` value and the parent collection ID as the `source` value. The response returns a task `id` value, which you can use to track the merge's status with the GET `/collection-merges-tasks/{taskId}` endpoint. operationId: asyncMergePullCollectionFork tags: - Collections - Forks requestBody: $ref: '#/components/requestBodies/asyncCollectionForkMerge' responses: '200': $ref: '#/components/responses/asyncMergeCollectionFork' '400': $ref: '#/components/responses/collectionForks400ErrorMalformedRequest' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/collectionForks403ErrorForbidden' '500': $ref: '#/components/responses/common500Error' /collection-merges-tasks/{taskId}: get: summary: Get merge or pull task status description: | Gets the status of a collection's merge or a pull changes task. **Note:** After a merge's success or failure, the task's status is only available for a period of 24 hours. Afterwards, this endpoint returns an HTTP `404 Not Found` response. operationId: asyncMergePullCollectionTaskStatus tags: - Collections - Forks responses: '200': $ref: '#/components/responses/asyncMergePullCollectionTaskStatus' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/collectionForks403ErrorForbidden' '404': $ref: '#/components/responses/collectionForks404ErrorTaskNotFound' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionForkTaskId' /collections: get: summary: Get all collections description: | Gets all of your [collections](https://www.postman.com/docs/collections). The response includes all of your subscribed collections. **Note:** - It's recommended that you use pagination with this endpoint. Pagination improves endpoint performance. Unpaginated calls are considered deprecated and are subject to change. - Filtering with the `name` parameter when you also pass the `limit` and `offset` parameters is not supported. - If you pass an invalid workspace ID for the `workspace` query parameter, this endpoint returns an HTTP `200 OK` response with an empty array. operationId: getCollections tags: - Collections responses: '200': $ref: '#/components/responses/getCollections' '401': $ref: '#/components/responses/common401Error' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceQuery' - $ref: '#/components/parameters/collectionNameQuery' - $ref: '#/components/parameters/limitNoDefault' - $ref: '#/components/parameters/offsetNoDefault' post: summary: Create a collection description: | Creates a collection using the [Postman Collection v2.1.0 schema format](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** If you do not include the `workspace` query parameter, the system creates the collection in the oldest personal Internal workspace you own. operationId: createCollection tags: - Collections requestBody: $ref: '#/components/requestBodies/createCollection' responses: '200': $ref: '#/components/responses/createCollection' '400': $ref: '#/components/responses/collection400ErrorInstanceFound' '401': $ref: '#/components/responses/common401Error' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceQueryTrue' /collections/collection-forks: get: summary: Get all forked collections description: Gets a list of all the authenticated user's forked collections. operationId: getCollectionsForkedByUser tags: - Collections - Forks responses: '200': $ref: '#/components/responses/getCollectionsForkedByUser' '400': $ref: '#/components/responses/fork400ErrorNoUserFound' '401': $ref: '#/components/responses/common401Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/createdAtSort' /collections/fork/{collectionId}: post: summary: Create a fork description: Creates a [fork](https://learning.postman.com/docs/collaborating-in-postman/version-control/#creating-a-fork) from an existing collection into a workspace. operationId: createCollectionFork tags: - Collections - Forks requestBody: $ref: '#/components/requestBodies/createCollectionFork' responses: '200': $ref: '#/components/responses/createCollectionFork' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/instanceNotFoundCollection' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/forkWorkspaceQuery' parameters: - $ref: '#/components/parameters/collectionId' /collections/merge: post: summary: Merge a fork description: | **This endpoint is deprecated.** Merges a forked collection back into its parent collection. You must have the [Editor role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#collection-roles) for the collection to merge a fork. operationId: mergeCollectionFork deprecated: true tags: - Collections - Forks requestBody: $ref: '#/components/requestBodies/mergeCollectionFork' responses: '200': $ref: '#/components/responses/mergeCollectionFork' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/instanceNotFoundCollection' '500': $ref: '#/components/responses/common500Error' /collections/{collectionId}: get: summary: Get a collection description: Gets information about a collection. For a complete list of this endpoint's possible values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). operationId: getCollection tags: - Collections responses: '200': $ref: '#/components/responses/getCollection' '400': $ref: '#/components/responses/collection400ErrorCollectionNotFound' '401': $ref: '#/components/responses/common401Error' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' security: - PostmanApiKey: [] - {} parameters: - $ref: '#/components/parameters/collectionAccessKeyQuery' - $ref: '#/components/parameters/collectionModelQuery' put: summary: Replace a collection's data description: | Replaces the contents of a collection using the [Postman Collection v2.1.0 schema format](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). Include the collection's ID values in the request body. If you do not, the endpoint removes the existing items and creates new items. - To perform an update asynchronously, use the `Prefer` header with the `respond-async` value. When performing an async update, this endpoint returns a HTTP `202 Accepted` response. - For a complete list of properties and information, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). - For protocol profile behavior, refer to Postman's [Protocol Profile Behavior documentation](https://github.com/postmanlabs/postman-runtime/blob/develop/docs/protocol-profile-behavior.md). **Note:** - The maximum collection size this endpoint accepts cannot exceed 100 MB. - Use the GET `/collection-updates-tasks/{taskId}` endpoint to get the collection's update status when performing an asynchronous update. - If you don't include the collection items' ID values from the request body, the endpoint **removes** the existing items and recreates the items with new ID values. - 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 `postman_id` values. operationId: putCollection tags: - Collections requestBody: $ref: '#/components/requestBodies/putCollection' responses: '200': $ref: '#/components/responses/putCollection' '202': $ref: '#/components/responses/putCollectionAsync' '400': $ref: '#/components/responses/collectionPut400Errors' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/collectionPut404Errors' '409': $ref: '#/components/responses/collectionPut409Errors' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/Prefer' patch: summary: Update part of a collection description: | Updates specific collection information, such as its name, events, or its variables. For more information, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). operationId: patchCollection tags: - Collections requestBody: $ref: '#/components/requestBodies/patchCollection' responses: '200': $ref: '#/components/responses/patchCollection' '400': $ref: '#/components/responses/collectionPatch400Errors' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/instanceNotFoundCollection' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' delete: summary: Delete a collection description: Deletes a collection. operationId: deleteCollection tags: - Collections responses: '200': $ref: '#/components/responses/deleteCollection' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/instanceNotFoundCollection' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionId' /collections/{collectionId}/comments: get: summary: Get a collection's comments description: Gets all comments left by users in a collection. operationId: getCollectionComments tags: - Collections - Comments responses: '200': $ref: '#/components/responses/commentGet' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' post: summary: Create a collection comment description: | Creates a comment on a collection. To create a reply on an existing comment, include the `threadId` property in the request body. **Note:** This endpoint accepts a max of 10,000 characters. tags: - Collections - Comments operationId: createCollectionComment requestBody: $ref: '#/components/requestBodies/commentCreate' responses: '201': $ref: '#/components/responses/commentCreated' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' parameters: - $ref: '#/components/parameters/collectionUid' /collections/{collectionId}/comments/{commentId}: put: summary: Update a collection's comment description: | Updates a comment on a collection. **Note:** This endpoint accepts a max of 10,000 characters. operationId: updateCollectionComment tags: - Collections - Comments requestBody: $ref: '#/components/requestBodies/commentUpdate' responses: '200': $ref: '#/components/responses/commentUpdated' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' delete: summary: Delete a collection's comment description: | 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. operationId: deleteCollectionComment tags: - Collections - Comments responses: '204': description: No Content '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' parameters: - $ref: '#/components/parameters/collectionUid' - $ref: '#/components/parameters/commentId' /collections/{collectionId}/duplicates: post: summary: Duplicate a collection description: | Creates a duplicate of the given collection in another workspace. Use the GET `/collection-duplicate-tasks/{taskId}` endpoint to get the duplication task's current status. tags: - Collections operationId: duplicateCollection requestBody: $ref: '#/components/requestBodies/duplicateCollection' responses: '200': $ref: '#/components/responses/duplicateCollection' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionUid' /collections/{collectionId}/folders: post: summary: Create a folder description: | Creates a folder in a collection. For a complete list of properties, refer to the **Folder** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). 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 example. **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. operationId: createCollectionFolder tags: - Collection Items - Collection Folders requestBody: $ref: '#/components/requestBodies/createCollectionFolder' responses: '200': $ref: '#/components/responses/createCollectionFolder' '400': $ref: '#/components/responses/collectionFolder400Error' '401': $ref: '#/components/responses/collectionFolder401Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionId' /collections/{collectionId}/folders/{folderId}/comments: get: summary: Get a folder's comments description: Gets all comments left by users in a folder. operationId: getFolderComments tags: - Collection Folders - Comments responses: '200': $ref: '#/components/responses/commentGet' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' post: summary: Create a folder comment description: | Creates a comment on a folder. To create a reply on an existing comment, include the `threadId` property in the request body. **Note:** This endpoint accepts a max of 10,000 characters. tags: - Collection Folders - Comments operationId: createFolderComment requestBody: $ref: '#/components/requestBodies/commentCreate' responses: '201': $ref: '#/components/responses/commentCreated' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' parameters: - $ref: '#/components/parameters/collectionUid' - $ref: '#/components/parameters/collectionFolderUid' /collections/{collectionId}/folders/{folderId}/comments/{commentId}: put: summary: Update a folder's comment description: | Updates a comment on a folder. **Note:** This endpoint accepts a max of 10,000 characters. operationId: updateFolderComment tags: - Collection Folders - Comments requestBody: $ref: '#/components/requestBodies/commentUpdate' responses: '200': $ref: '#/components/responses/commentUpdated' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' delete: summary: Delete a folder's comment description: | 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. operationId: deleteFolderComment tags: - Collection Folders - Comments responses: '204': description: No Content '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' parameters: - $ref: '#/components/parameters/collectionUid' - $ref: '#/components/parameters/collectionFolderUid' - $ref: '#/components/parameters/commentId' /collections/{collectionId}/forks: get: summary: Get a collection's forks description: 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. operationId: getCollectionForks tags: - Collections - Forks responses: '200': $ref: '#/components/responses/getCollectionForks' '400': $ref: '#/components/responses/forkCollection400ErrorNoForks' '404': $ref: '#/components/responses/fork404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/createdAtSort' parameters: - $ref: '#/components/parameters/collectionId' /collections/{collectionUid}/generations/{elementType}: get: summary: Get generated spec description: Gets the API specification generated for the given collection. tags: - Specs - Generated Specs operationId: getGeneratedCollectionSpecs responses: '200': $ref: '#/components/responses/getGeneratedCollectionSpecs' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '500': $ref: '#/components/responses/common500Error' post: summary: Generate spec from collection description: Generates an OpenAPI 2.0, 3.0, or 3.1 specification for the given collection. The response contains a polling link to the task status. tags: - Specs - Generated Specs operationId: generateSpecFromCollection requestBody: $ref: '#/components/requestBodies/generateSpecFromCollection' responses: '200': $ref: '#/components/responses/generateTaskResponse' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '423': $ref: '#/components/responses/apiSpec423ErrorLocked' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionUniqueId' - $ref: '#/components/parameters/elementTypeSpec' /collections/{collectionId}/public-documentations: put: summary: Publish documentation description: | Publishes a collection's documentation. This makes it publicly available to anyone with the link to the documentation. **Note:** - Your [Postman plan](https://www.postman.com/pricing/) impacts your use of these endpoints: - For **Free** and **Solo** users, you must have permissions to edit the collection. - If [API Governance and Security](https://learning.postman.com/docs/api-governance/configurable-rules/configurable-rules-overview/) is enabled for your [**Enterprise**](https://www.postman.com/pricing/) team, only users with the [Community Manager role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) can publish documentation. - Publishing is only supported for collections with HTTP requests. - You cannot publish a collection added to an API. tags: - Collections - Documentation operationId: publishDocumentation requestBody: $ref: '#/components/requestBodies/publishDocumentation' responses: '200': $ref: '#/components/responses/publishDocumentationResponse' '400': $ref: '#/components/responses/documentation400ErrorBadRequest' '401': $ref: '#/components/responses/documentation401ErrorUnauthorized' '403': $ref: '#/components/responses/documentation403ErrorForbidden' '500': $ref: '#/components/responses/documentation500ErrorServerError' delete: summary: Unpublish documentation description: Unpublishes a collection's documentation. On success, this returns an HTTP `204 No Content` response. tags: - Collections - Documentation operationId: unpublishDocumentation responses: '204': description: No Content '400': $ref: '#/components/responses/documentation400ErrorBadRequest' '401': $ref: '#/components/responses/documentation401ErrorUnauthorized' '404': $ref: '#/components/responses/documentation404ErrorNotFound' '500': $ref: '#/components/responses/documentation500ErrorServerError' parameters: - $ref: '#/components/parameters/collectionUid' /collections/{collectionId}/pulls: put: summary: Pull source changes description: | 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. operationId: pullCollectionChanges tags: - Collections - Forks responses: '200': $ref: '#/components/responses/pullCollectionChanges' '400': $ref: '#/components/responses/forkCollection400ErrorBadId' '404': $ref: '#/components/responses/instanceNotFoundCollection' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/forkedCollectionId' /collections/{collectionId}/pull-requests: get: summary: Get a collection's pull requests description: 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. operationId: getCollectionPullRequests tags: - Collections - Pull Requests responses: '200': $ref: '#/components/responses/getCollectionPullRequests' '403': $ref: '#/components/responses/pullRequest403Error' '500': $ref: '#/components/responses/common500Error' post: summary: Create a pull request description: Creates a pull request for a forked collection into its parent collection. operationId: createCollectionPullRequest tags: - Collections - Pull Requests requestBody: $ref: '#/components/requestBodies/pullRequestCreate' responses: '200': $ref: '#/components/responses/pullRequestCreated' '400': $ref: '#/components/responses/pullRequest400Error' '403': $ref: '#/components/responses/pullRequest403Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionUid' /collections/{collectionId}/requests: post: summary: Create a request description: | Creates a request in a collection. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **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. operationId: createCollectionRequest tags: - Collection Items - Collection Requests requestBody: $ref: '#/components/requestBodies/createCollectionRequest' responses: '200': $ref: '#/components/responses/createCollectionRequest' '400': $ref: '#/components/responses/collectionRequest400Error' '401': $ref: '#/components/responses/collectionRequest401Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionRequestFolderIdQuery' parameters: - $ref: '#/components/parameters/collectionId' /collections/{collectionId}/requests/{requestId}/comments: get: summary: Get a request's comments description: Gets all comments left by users in a request. operationId: getRequestComments tags: - Collection Requests - Comments responses: '200': $ref: '#/components/responses/commentGet' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' post: summary: Create a request comment description: | Creates a comment on a request. To create a reply on an existing comment, include the `threadId` property in the request body. **Note:** This endpoint accepts a max of 10,000 characters. tags: - Collection Requests - Comments operationId: createRequestComment requestBody: $ref: '#/components/requestBodies/commentCreate' responses: '201': $ref: '#/components/responses/commentCreated' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' parameters: - $ref: '#/components/parameters/collectionUid' - $ref: '#/components/parameters/collectionRequestUid' /collections/{collectionId}/requests/{requestId}/comments/{commentId}: put: summary: Update a request's comment description: | Updates a comment on a request. **Note:** This endpoint accepts a max of 10,000 characters. operationId: updateRequestComment tags: - Collection Requests - Comments requestBody: $ref: '#/components/requestBodies/commentUpdate' responses: '200': $ref: '#/components/responses/commentUpdated' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' delete: summary: Delete a request's comment description: | 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. operationId: deleteRequestComment tags: - Collection Requests - Comments responses: '204': description: No Content '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' parameters: - $ref: '#/components/parameters/collectionUid' - $ref: '#/components/parameters/collectionRequestUid' - $ref: '#/components/parameters/commentId' /collections/{collectionId}/responses: post: summary: Create a response description: | Creates a request response in a collection. For a complete list of request body properties, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **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. operationId: createCollectionResponse tags: - Collection Items - Collection Responses requestBody: $ref: '#/components/requestBodies/createCollectionResponse' responses: '200': $ref: '#/components/responses/createCollectionResponse' '400': $ref: '#/components/responses/collectionResponse400Error' '401': $ref: '#/components/responses/collectionResponse401Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionResponseParentRequestId' parameters: - $ref: '#/components/parameters/collectionId' /collections/{collectionId}/responses/{responseId}/comments: get: summary: Get a response's comments description: Gets all comments left by users in a response. operationId: getResponseComments tags: - Collection Responses - Comments responses: '200': $ref: '#/components/responses/commentGet' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' post: summary: Create a response comment description: | Creates a comment on a response. To create a reply on an existing comment, include the `threadId` property in the request body. **Note:** This endpoint accepts a max of 10,000 characters. tags: - Collection Responses - Comments operationId: createResponseComment requestBody: $ref: '#/components/requestBodies/commentCreate' responses: '201': $ref: '#/components/responses/commentCreated' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' parameters: - $ref: '#/components/parameters/collectionUid' - $ref: '#/components/parameters/collectionResponseUid' /collections/{collectionId}/responses/{responseId}/comments/{commentId}: put: summary: Update a response's comment description: | Updates a comment on a response. **Note:** This endpoint accepts a max of 10,000 characters. operationId: updateResponseComment tags: - Collection Responses - Comments requestBody: $ref: '#/components/requestBodies/commentUpdate' responses: '200': $ref: '#/components/responses/commentUpdated' '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' delete: summary: Delete a response's comment description: | 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. operationId: deleteResponseComment tags: - Collection Responses - Comments responses: '204': description: No Content '401': $ref: '#/components/responses/comment401Error' '403': $ref: '#/components/responses/comment403Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' parameters: - $ref: '#/components/parameters/collectionUid' - $ref: '#/components/parameters/collectionResponseUid' - $ref: '#/components/parameters/commentId' /collections/{collectionId}/roles: get: summary: Get a collection's roles description: 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. operationId: getCollectionRoles tags: - Collections - Roles responses: '200': $ref: '#/components/responses/getCollectionRoles' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/collection404ErrorInstanceNotFound' '500': $ref: '#/components/responses/common500Error' patch: summary: Update a collection's roles description: | Updates the roles of users, groups, or teams in a collection. On success, this returns an HTTP `204 No Content` response. **Note:** - Only users assigned the Editor [role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#collection-roles) in the collection can use this endpoint. - This endpoint does not support the external [Partner or Guest roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles). operationId: updateCollectionRoles tags: - Collections - Roles requestBody: $ref: '#/components/requestBodies/updateCollectionRoles' responses: '204': description: No Content '400': $ref: '#/components/responses/collectionRoles400ErrorMissingProperty' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/collection404ErrorInstanceNotFound' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionId' /collections/{collectionId}/source-status: get: summary: Get source collection's status description: | 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. operationId: getSourceCollectionStatus tags: - Collections - Forks responses: '200': $ref: '#/components/responses/getSourceCollectionStatus' '400': $ref: '#/components/responses/forkCollection400ErrorNotForked' '403': $ref: '#/components/responses/pullRequest403Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionId' /collections/{collectionUid}/synchronizations: put: summary: Sync collection with spec description: | Syncs a collection generated from an API specification. This is an asynchronous endpoint that returns an HTTP `202 Accepted` response. **Note:** - This endpoint only supports the OpenAPI 2.0, 3.0, and 3.1 specification types. - You can only sync collections generated from the given spec ID. tags: - Specs - Spec Collections operationId: syncCollectionWithSpec parameters: - $ref: '#/components/parameters/specIdQuery' responses: '202': $ref: '#/components/responses/generateTaskResponse' '403': $ref: '#/components/responses/api403Error' '404': $ref: '#/components/responses/apiSpec404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionUniqueId' /collections/{collectionId}/folders/{folderId}: get: summary: Get a folder description: Gets information about a folder in a collection. operationId: getCollectionFolder tags: - Collection Items - Collection Folders responses: '200': $ref: '#/components/responses/getCollectionFolder' '401': $ref: '#/components/responses/collectionFolder401Error' '404': $ref: '#/components/responses/collectionFolder404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionItemsIdQuery' - $ref: '#/components/parameters/collectionItemsUidFormatQuery' - $ref: '#/components/parameters/collectionItemsPopulateQuery' put: summary: Update a folder description: | Updates a folder in a collection. For a complete list of properties, refer to the **Folder** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **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. operationId: updateCollectionFolder tags: - Collection Items - Collection Folders requestBody: $ref: '#/components/requestBodies/updateCollectionFolder' responses: '200': $ref: '#/components/responses/updateCollectionFolder' '400': $ref: '#/components/responses/collectionFolder400Error' '401': $ref: '#/components/responses/collectionFolder401Error' '404': $ref: '#/components/responses/collectionFolder404Error' '500': $ref: '#/components/responses/common500Error' delete: summary: Delete a folder description: Deletes a folder in a collection. operationId: deleteCollectionFolder tags: - Collection Items - Collection Folders responses: '200': $ref: '#/components/responses/deleteCollectionFolder' '401': $ref: '#/components/responses/collectionFolder401Error' '404': $ref: '#/components/responses/collectionFolder404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionFolderId' - $ref: '#/components/parameters/collectionId' /collections/{collectionId}/requests/{requestId}: get: summary: Get a request description: Gets information about a request in a collection. operationId: getCollectionRequest tags: - Collection Items - Collection Requests responses: '200': $ref: '#/components/responses/getCollectionRequest' '401': $ref: '#/components/responses/collectionRequest401Error' '404': $ref: '#/components/responses/collectionRequest404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionItemsIdQuery' - $ref: '#/components/parameters/collectionItemsUidFormatQuery' - $ref: '#/components/parameters/collectionItemsPopulateQuery' put: summary: Update a request description: | Updates a request in a collection. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** - You must pass a collection ID (`12ece9e1-2abf-4edc-8e34-de66e74114d2`), not a collection(`12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2`), in this endpoint. - This endpoint does not support changing the folder of a request. operationId: updateCollectionRequest tags: - Collection Items - Collection Requests requestBody: $ref: '#/components/requestBodies/updateCollectionRequest' responses: '200': $ref: '#/components/responses/updateCollectionRequest' '400': $ref: '#/components/responses/collectionRequest400Error' '401': $ref: '#/components/responses/collectionRequest401Error' '404': $ref: '#/components/responses/collectionRequest404Error' '500': $ref: '#/components/responses/common500Error' delete: summary: Delete a request description: Deletes a request in a collection. operationId: deleteCollectionRequest tags: - Collection Items - Collection Requests responses: '200': $ref: '#/components/responses/deleteCollectionRequest' '401': $ref: '#/components/responses/collectionRequest401Error' '404': $ref: '#/components/responses/collectionRequest404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionRequestId' - $ref: '#/components/parameters/collectionId' /collections/{collectionId}/responses/{responseId}: get: summary: Get a response description: Gets information about a response in a collection. operationId: getCollectionResponse tags: - Collection Items - Collection Responses responses: '200': $ref: '#/components/responses/getCollectionResponse' '401': $ref: '#/components/responses/collectionResponse401Error' '404': $ref: '#/components/responses/collectionResponse404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionItemsIdQuery' - $ref: '#/components/parameters/collectionItemsUidFormatQuery' - $ref: '#/components/parameters/collectionItemsPopulateQuery' put: summary: Update a response description: | Updates a response in a collection. For a complete list of properties, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **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. operationId: updateCollectionResponse tags: - Collection Items - Collection Responses requestBody: $ref: '#/components/requestBodies/updateCollectionResponse' responses: '200': $ref: '#/components/responses/updateCollectionResponse' '400': $ref: '#/components/responses/collectionResponse400Error' '401': $ref: '#/components/responses/collectionResponse401Error' '404': $ref: '#/components/responses/collectionResponse404Error' '500': $ref: '#/components/responses/common500Error' delete: summary: Delete a response description: Deletes a response in a collection. operationId: deleteCollectionResponse tags: - Collection Items - Collection Responses responses: '200': $ref: '#/components/responses/deleteCollectionResponse' '401': $ref: '#/components/responses/collectionResponse401Error' '404': $ref: '#/components/responses/collectionResponse404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/collectionResponseId' - $ref: '#/components/parameters/collectionId' /collections/{collectionId}/tags: get: summary: Get a collection's tags description: Gets all the tags associated with a collection. operationId: getCollectionTags tags: - Tags - Collection Tags responses: '200': $ref: '#/components/responses/tagGetPut' '401': $ref: '#/components/responses/tag401Error' '403': $ref: '#/components/responses/tag403Error' '500': $ref: '#/components/responses/tag500Error' put: summary: Update a collection's tags description: Updates a collection's associated tags. This endpoint replaces all existing tags with those you pass in the request body. operationId: updateCollectionTags tags: - Tags - Collection Tags requestBody: $ref: '#/components/requestBodies/tagUpdateTags' responses: '200': $ref: '#/components/responses/tagGetPut' '400': $ref: '#/components/responses/tag400Error' '401': $ref: '#/components/responses/tag401Error' '403': $ref: '#/components/responses/tag403Error' '404': $ref: '#/components/responses/tag404Error' '500': $ref: '#/components/responses/tag500Error' parameters: - $ref: '#/components/parameters/collectionUid' /collections/{collectionId}/transformations: get: summary: Transform collection to OpenAPI description: | **This endpoint is deprecated.** Use the POST `/collections/{collectionUid}/generations/{elementType}` endpoint to generate an OpenAPI specification from a collection. operationId: transformCollectionToOpenAPI deprecated: true tags: - Collections - Collection to API responses: '200': $ref: '#/components/responses/transformCollectionToOpenAPI' '401': $ref: '#/components/responses/collectionToApi401Error' '404': $ref: '#/components/responses/collectionToApi404Error' '500': $ref: '#/components/responses/collectionToApi500Error' parameters: - $ref: '#/components/parameters/collectionTransformFormat' parameters: - $ref: '#/components/parameters/collectionId' /collection-folders-transfers: post: summary: Transfer folders description: Copies or moves folders into a collection or folder. operationId: transferCollectionFolders tags: - Collections - Transfer Collection Items requestBody: $ref: '#/components/requestBodies/transferCollectionItems' responses: '200': $ref: '#/components/responses/transferCollectionItemsResponse' '400': $ref: '#/components/responses/transferCollectionItems400Error' '500': $ref: '#/components/responses/common500Error' /collection-requests-transfers: post: summary: Transfer requests description: Copies or moves requests into a collection or folder. operationId: transferCollectionRequests tags: - Collections - Transfer Collection Items requestBody: $ref: '#/components/requestBodies/transferCollectionItems' responses: '200': $ref: '#/components/responses/transferCollectionItemsResponse' '400': $ref: '#/components/responses/transferCollectionItems400Error' '500': $ref: '#/components/responses/common500Error' /collection-responses-transfers: post: summary: Transfer responses description: Copies or moves responses into a request. operationId: transferCollectionResponses tags: - Collections - Transfer Collection Items requestBody: $ref: '#/components/requestBodies/transferCollectionItems' responses: '200': $ref: '#/components/responses/transferCollectionItemsResponse' '400': $ref: '#/components/responses/transferCollectionItems400Error' '500': $ref: '#/components/responses/common500Error' /collection-duplicate-tasks/{taskId}: get: summary: Get duplication task status description: Gets the status of a collection duplication task. tags: - Collections operationId: getDuplicateCollectionTaskStatus responses: '200': $ref: '#/components/responses/getDuplicateCollectionTaskStatus' '400': $ref: '#/components/responses/duplicationTask400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/taskUid' /collection-updates-tasks/{taskId}: get: summary: Get async collection update status description: Gets the status of an asynchronous collection update task. operationId: getCollectionUpdatesTasks tags: - Collections responses: '200': $ref: '#/components/responses/getCollectionUpdatesTasks' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/taskId' /comments-resolutions/{threadId}: post: summary: Resolve a comment thread description: | Resolves a comment and any associated replies. On success, this returns an HTTP `204 No Content` response. Comment thread IDs return in the GET `/comments` response for [collections](https://www.postman.com/postman/workspace/postman-public-workspace/request/12959542-a6582e0a-9382-4760-8b91-53a8aa6cb8d7) and [collection items](https://www.postman.com/postman/workspace/postman-public-workspace/folder/12959542-efeda219-66e1-474c-a83b-253d15723bf7). operationId: resolveCommentThread tags: - Comments responses: '204': description: Successful Response '401': $ref: '#/components/responses/comment401Error' '404': $ref: '#/components/responses/comment404Error' '500': $ref: '#/components/responses/comment500Error' parameters: - $ref: '#/components/parameters/threadId' /components: post: summary: Create a component description: Creates a new component. The component is created in an active state with an initial draft. Use the POST `/components/{componentId}/versions` endpoint to publish a version. operationId: createComponent x-postman-plan: Enterprise tags: - Components requestBody: $ref: '#/components/requestBodies/createComponent' responses: '201': $ref: '#/components/responses/createComponentResponse' '400': $ref: '#/components/responses/componentLibrary400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '409': $ref: '#/components/responses/componentLibrary409Error' '500': $ref: '#/components/responses/common500Error' get: summary: Get all components description: Gets a list of all components in the team's component library. operationId: getAllComponents x-postman-plan: Enterprise tags: - Components responses: '200': $ref: '#/components/responses/getAllComponents' '400': $ref: '#/components/responses/componentLibrary400Error' '401': $ref: '#/components/responses/common401Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/componentType' - $ref: '#/components/parameters/componentStatus' - $ref: '#/components/parameters/componentHasVersions' - $ref: '#/components/parameters/componentIncludeFields' - $ref: '#/components/parameters/componentExpandLatestVersion' /components/{componentId}: patch: summary: Update a component description: | Updates a component: - `name` — Rename the component. The new name must be unique within the team. Archived components can't be renamed. - `status` — Changes the component's lifecycle state: - `archive` — Marks the component as read-only. Archived components aren't deleted and can't be edited or published, but their existing versions remain accessible. - `active` — Restores the component. Only active components can be edited and published. **Note:** You can't update a name and archived state in a single call. To change both properties, make separate calls to update the name and status. operationId: updateComponent x-postman-plan: Enterprise tags: - Components requestBody: $ref: '#/components/requestBodies/updateComponent' responses: '200': $ref: '#/components/responses/updateComponentResponse' '400': $ref: '#/components/responses/componentLibrary400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/componentLibrary404Error' '409': $ref: '#/components/responses/componentLibrary409Error' '500': $ref: '#/components/responses/common500Error' get: summary: Get a component description: Gets information about a component. Use the `include` and `expand` query parameters to return additional information, such as `hasVersions` and the latest published version. operationId: getComponent x-postman-plan: Enterprise parameters: - $ref: '#/components/parameters/componentIncludeFields' - $ref: '#/components/parameters/componentExpandLatestVersion' responses: '200': $ref: '#/components/responses/getComponent' '400': $ref: '#/components/responses/componentLibrary400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/componentLibrary404Error' '500': $ref: '#/components/responses/common500Error' tags: - Components parameters: - $ref: '#/components/parameters/componentId' /components/{componentId}/drafts: patch: summary: Update a component draft description: | Updates a component's draft. Component drafts contain unpublished edits to a component, which may be different from a recently published version. **Note:** You can't update archived components. operationId: updateComponentDraft x-postman-plan: Enterprise tags: - Components - Component Drafts requestBody: $ref: '#/components/requestBodies/updateComponentDraft' responses: '200': $ref: '#/components/responses/updateComponentDraftResponse' '400': $ref: '#/components/responses/componentLibrary400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/componentLibrary404Error' '409': $ref: '#/components/responses/componentLibrary409Error' '500': $ref: '#/components/responses/common500Error' get: summary: Get a component draft description: Gets information about the current working draft of a component, including its content and format. Drafts represent the latest unpublished edits of a component, which may be different from the most recently published version. operationId: getComponentDraft x-postman-plan: Enterprise tags: - Components - Component Drafts responses: '200': $ref: '#/components/responses/getComponentDraft' '400': $ref: '#/components/responses/componentLibrary400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/componentLibrary404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/componentId' /components/{componentId}/versions: post: summary: Create a component version description: | Publishes a new version of a component from the current draft. **Note:** You can't publish a new version of an archived component. Reactivate the component before publishing a new version. operationId: createComponentVersion x-postman-plan: Enterprise tags: - Components - Component Versions requestBody: $ref: '#/components/requestBodies/createComponentVersion' responses: '201': $ref: '#/components/responses/createComponentVersionResponse' '400': $ref: '#/components/responses/componentLibrary400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/componentLibrary404Error' '409': $ref: '#/components/responses/componentLibrary409Error' '500': $ref: '#/components/responses/common500Error' get: summary: Get all component versions description: Gets a list of a component's published versions. operationId: getComponentVersions x-postman-plan: Enterprise tags: - Components - Component Versions responses: '200': $ref: '#/components/responses/getComponentVersions' '400': $ref: '#/components/responses/componentLibrary400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/componentLibrary404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/componentLibraryInclude' parameters: - $ref: '#/components/parameters/componentId' /components/{componentId}/versions/{versionId}: get: summary: Get a component version description: Gets a published version of a component. operationId: getComponentVersion x-postman-plan: Enterprise tags: - Components - Component Versions responses: '200': $ref: '#/components/responses/getComponentVersion' '400': $ref: '#/components/responses/componentLibrary400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/componentLibrary404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/componentLibraryInclude' parameters: - $ref: '#/components/parameters/componentId' - $ref: '#/components/parameters/componentVersionId' /context-graph/asks: post: summary: Submit a Context Graph ask description: | Submits a natural-language question about your team's Context Graph. Asks are asynchronous. On success, this returns an HTTP `202 Accepted` response with the ask's `askId`. Send a request to the GET `/context-graph/asks/{askId}` endpoint to poll the ask for its status and, once it completes, its result. **Note:** Postman derives the team from your API key. operationId: submitContextGraphAsk tags: - Context Graph requestBody: $ref: '#/components/requestBodies/submitContextGraphAsk' responses: '202': $ref: '#/components/responses/submitContextGraphAsk' '400': $ref: '#/components/responses/contextGraph400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/contextGraph403Error' '429': $ref: '#/components/responses/contextGraph429Error' '500': $ref: '#/components/responses/common500Error' /context-graph/asks/{askId}: get: summary: Get a Context Graph ask description: | Gets a submitted ask's status and, once the ask completes, its result. Poll this endpoint after submitting an ask. The `status` property is `pending` or `running` while the ask is in progress, and `completed` or `failed` once it reaches a terminal state. The `result` property is only present once `status` is `completed`. operationId: getContextGraphAsk tags: - Context Graph responses: '200': $ref: '#/components/responses/getContextGraphAsk' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/contextGraph403Error' '404': $ref: '#/components/responses/contextGraphAsk404Error' '429': $ref: '#/components/responses/contextGraph429Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/contextGraphAskId' /custom-functions: get: summary: Get all custom functions description: Gets a list of the team's custom functions. The response doesn't include function content. operationId: getAllCustomFunctions tags: - API Governance - Custom Functions parameters: - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit-2' responses: '200': $ref: '#/components/responses/getAllCustomFunctions' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '500': $ref: '#/components/responses/common500Error' post: summary: Create a custom function description: Creates a new custom function for the team. operationId: createCustomFunction tags: - API Governance - Custom Functions requestBody: $ref: '#/components/requestBodies/createCustomFunction' responses: '201': $ref: '#/components/responses/createCustomFunction' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '409': $ref: '#/components/responses/customFunction409Conflict' '500': $ref: '#/components/responses/common500Error' /custom-functions/{customFunctionId}: get: summary: Get a custom function description: | Gets information about a custom function. By default, the response only returns the custom function's metadata. To include custom function contents in the response, pass the `include` query parameter. operationId: getCustomFunction tags: - API Governance - Custom Functions parameters: - $ref: '#/components/parameters/apiGovernanceInclude' responses: '200': $ref: '#/components/responses/getCustomFunction' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '500': $ref: '#/components/responses/common500Error' patch: summary: Update a custom function description: Updates a custom function. Only the fields present in the request body are updated. If `content` is provided, it replaces the entire contents of the custom function. operationId: updateCustomFunction tags: - API Governance - Custom Functions requestBody: $ref: '#/components/requestBodies/updateCustomFunction' responses: '200': $ref: '#/components/responses/updateCustomFunction' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '409': $ref: '#/components/responses/customFunction409Conflict' '500': $ref: '#/components/responses/common500Error' delete: summary: Delete a custom function description: Deletes a custom function. On success, this returns a `204 No Content` response. operationId: deleteCustomFunction tags: - API Governance - Custom Functions responses: '204': description: Deleted '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/customFunctionId' /detected-secrets-queries: post: summary: Search detected secrets description: Returns all secrets detected by Postman's [Secret Scanner](https://learning.postman.com/docs/administration/secret-scanner/), grouped by workspace or resource. If you pass an empty request body, this endpoint returns all results. operationId: detectedSecretsQueries x-postman-plan: Enterprise tags: - Secret Scanner - Detected Secrets parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/include' - $ref: '#/components/parameters/sinceUrlEncode' - $ref: '#/components/parameters/untilUrlEncode' requestBody: $ref: '#/components/requestBodies/detectedSecretsQueries' responses: '200': $ref: '#/components/responses/detectedSecretsQueries' '400': $ref: '#/components/responses/detectedSecretsQuery400Errors' '401': $ref: '#/components/responses/secretScanner401Error' '403': $ref: '#/components/responses/secretScanner403Error' '500': $ref: '#/components/responses/secretScanner500Error' /detected-secrets/{secretId}: put: summary: Update detected secret resolution status description: Updates the resolution status of a secret detected in a workspace. operationId: updateDetectedSecretResolutions x-postman-plan: Enterprise tags: - Secret Scanner - Detected Secrets requestBody: $ref: '#/components/requestBodies/updateSecretResolutions' responses: '200': $ref: '#/components/responses/updateSecretResolutions' '400': $ref: '#/components/responses/secretScanner400InvalidResolutionError' '401': $ref: '#/components/responses/secretScanner401Error' '403': $ref: '#/components/responses/secretScanner403Error' '500': $ref: '#/components/responses/secretScanner500Error' parameters: - $ref: '#/components/parameters/secretId' /detected-secrets/{secretId}/locations: get: summary: Get detected secrets locations description: Gets the locations of secrets detected by Postman's [Secret Scanner](https://learning.postman.com/docs/administration/secret-scanner/). operationId: getDetectedSecretsLocations x-postman-plan: Enterprise tags: - Secret Scanner - Detected Secrets parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/workspaceIdQueryTrue' - $ref: '#/components/parameters/sinceUrlEncode' - $ref: '#/components/parameters/untilUrlEncode' - $ref: '#/components/parameters/resourceType' responses: '200': $ref: '#/components/responses/getSecretsLocations' '400': $ref: '#/components/responses/secretScanner400Error' '401': $ref: '#/components/responses/secretScanner401Error' '403': $ref: '#/components/responses/secretScanner403Error' '500': $ref: '#/components/responses/secretScanner500Error' parameters: - $ref: '#/components/parameters/secretId' /{elementType}/{elementId}/tasks/{taskId}: get: summary: Get status of an async spec task description: Gets the status of an asynchronous API specification creation task. tags: - Specs operationId: getAsyncSpecTaskStatus responses: '200': $ref: '#/components/responses/getAsyncCollectionTaskStatus' '401': $ref: '#/components/responses/apiSpec401Error' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/elementType' - $ref: '#/components/parameters/elementId' - $ref: '#/components/parameters/taskId' /environments: get: summary: Get all environments description: Gets information about all of your [environments](https://learning.postman.com/docs/sending-requests/managing-environments/). operationId: getEnvironments tags: - Environments responses: '200': $ref: '#/components/responses/getEnvironments' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/environments404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceQuery' post: summary: Create an environment description: | Creates an environment. **Note:** - The request body size cannot exceed the maximum allowed size of 30MB. - If you receive an HTTP `411 Length Required` error response, manually pass the `Content-Length` header and its value in the request header. - If you do not include the `workspace` query parameter, the system creates the environment in the oldest personal Internal workspace you own. - Only [shared variable](https://learning.postman.com/docs/use/send-requests/variables/variables/#share-variable-values) values can be modified through the Postman API. A shared variable is an environment variable with its value synced and stored in the Postman cloud, and can be accessed by your teammates in the environment's workspace. operationId: createEnvironment tags: - Environments requestBody: $ref: '#/components/requestBodies/createEnvironment' responses: '200': $ref: '#/components/responses/createEnvironment' '400': $ref: '#/components/responses/environment400Errors' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '411': $ref: '#/components/responses/common411Error' '413': $ref: '#/components/responses/common413Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceQueryTrue' /environments/{environmentId}: get: summary: Get an environment description: Gets information about an environment. operationId: getEnvironment tags: - Environments responses: '200': $ref: '#/components/responses/getEnvironment' '400': $ref: '#/components/responses/environments404Error' '401': $ref: '#/components/responses/common401Error' '500': $ref: '#/components/responses/common500Error' patch: summary: Update an environment description: | Updates specific environment properties, such as its name and variables. **Note:** - You can only perform one type of operation at a time. For example, you cannot perform an `add` and `replace` operation in the same call. - The request body size cannot exceed the maximum allowed size of 30MB. - If you receive an HTTP `411 Length Required` error response, manually pass the `Content-Length` header and its value in the request header. - To add a description to an existing variable, use the `add` operation. - Only [shared variable](https://learning.postman.com/docs/use/send-requests/variables/variables/#share-variable-values) values can be modified through the Postman API. A shared variable is an environment variable with its value synced and stored in the Postman cloud, and can be accessed by your teammates in the environment's workspace. operationId: patchEnvironment tags: - Environments requestBody: $ref: '#/components/requestBodies/patchEnvironment' responses: '200': $ref: '#/components/responses/patchEnvironment' '400': $ref: '#/components/responses/patchEnvironment400Error' '403': $ref: '#/components/responses/environments403Error' '404': $ref: '#/components/responses/environments404Error' '411': $ref: '#/components/responses/common411Error' '413': $ref: '#/components/responses/common413Error' '500': $ref: '#/components/responses/common500Error' put: summary: Replace an environment's data description: | Replaces all the contents of an environment with the given information. **Note:** - The request body size cannot exceed the maximum allowed size of 30MB. - If you receive an HTTP `411 Length Required` error response, manually pass the `Content-Length` header and its value in the request header. - Only [shared variable](https://learning.postman.com/docs/use/send-requests/variables/variables/#share-variable-values) values can be modified through the Postman API. A shared variable is an environment variable with its value synced and stored in the Postman cloud, and can be accessed by your teammates in the environment's workspace. operationId: putEnvironment tags: - Environments requestBody: $ref: '#/components/requestBodies/putEnvironment' responses: '200': $ref: '#/components/responses/putEnvironment' '400': $ref: '#/components/responses/environment400Errors' '401': $ref: '#/components/responses/common401Error' '411': $ref: '#/components/responses/common411Error' '413': $ref: '#/components/responses/common413Error' '500': $ref: '#/components/responses/common500Error' delete: summary: Delete an environment description: Deletes an environment. operationId: deleteEnvironment tags: - Environments responses: '200': $ref: '#/components/responses/deleteEnvironment' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/environments404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/environmentId' /environments/{environmentId}/forks: post: summary: Create a fork description: Creates a [fork](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/) of an existing environment. operationId: forkEnvironment tags: - Environments - Forks requestBody: $ref: '#/components/requestBodies/forkEnvironment' responses: '200': $ref: '#/components/responses/forkEnvironment' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/environmentForks404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceIdQueryTrue' get: summary: Get an environment's forks description: Gets all of an environment's forked environments. operationId: getEnvironmentForks tags: - Environments - Forks responses: '200': $ref: '#/components/responses/getEnvironmentForks' '400': $ref: '#/components/responses/environmentForks400Error' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/environmentForks404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/directionQuery' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/sortByCreatedAt' parameters: - $ref: '#/components/parameters/environmentUid' /environments/{environmentId}/merges: post: summary: Merge a fork description: | [Merges](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/#merge-changes-from-a-fork) a forked environment back into its parent environment. operationId: mergeEnvironmentFork tags: - Environments - Forks requestBody: $ref: '#/components/requestBodies/mergeEnvironmentFork' responses: '200': $ref: '#/components/responses/mergeEnvironmentFork' '400': $ref: '#/components/responses/environmentForks400Error' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/environmentForks404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/environmentUid' /environments/{environmentUid}/pulls: post: summary: Pull source changes description: | [Pulls](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/#pull-updates-from-a-parent-element) the changes from a parent (source) environment into the forked environment. operationId: pullEnvironment tags: - Environments - Forks requestBody: $ref: '#/components/requestBodies/pullEnvironment' responses: '200': $ref: '#/components/responses/pullEnvironment' '400': $ref: '#/components/responses/environmentForks400Error' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/environmentForks404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/destinationEnvironmentUid' /governance-groups: get: summary: Get all governance groups description: Gets a list of the team's governance groups. operationId: getAllGovernanceGroups tags: - API Governance - Governance Groups parameters: - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit-2' responses: '200': $ref: '#/components/responses/getAllGovernanceGroups' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '500': $ref: '#/components/responses/common500Error' post: summary: Create a governance group description: Creates a custom governance group for the team. operationId: createGovernanceGroup tags: - API Governance - Governance Groups requestBody: $ref: '#/components/requestBodies/createGovernanceGroup' responses: '201': $ref: '#/components/responses/createGovernanceGroup' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '409': $ref: '#/components/responses/governanceGroup409Conflict' '500': $ref: '#/components/responses/common500Error' /governance-groups/{groupId}: patch: summary: Update a governance group description: | Updates a governance group's name or description. **Note:** Postman-managed governance groups (`type: system`) can't be updated and return an HTTP `403 Forbidden` response. operationId: updateGovernanceGroup tags: - API Governance - Governance Groups requestBody: $ref: '#/components/requestBodies/updateGovernanceGroup' responses: '200': $ref: '#/components/responses/updateGovernanceGroup' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '409': $ref: '#/components/responses/governanceGroup409Conflict' '500': $ref: '#/components/responses/common500Error' delete: summary: Delete a governance group description: | Deletes a governance group. This also removes the group's workspace assignments and any ruleset assignments targeting the group. Workspaces and rulesets aren't deleted. On success, this returns an HTTP `204 No Content` response. **Note:** Postman-managed governance groups (`type: system`) can't be deleted and return an HTTP `403 Forbidden` response. operationId: deleteGovernanceGroup tags: - API Governance - Governance Groups responses: '204': description: Governance group deleted. '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/governanceGroupId' /governance-groups/{groupId}/assignments: get: summary: Get a governance group's ruleset assignments description: Gets the rulesets assigned to a governance group. operationId: getGovernanceGroupAssignments tags: - API Governance - Governance Groups responses: '200': $ref: '#/components/responses/getGovernanceGroupAssignments' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/governanceGroupId' /governance-groups/{groupId}/workspaces: get: summary: Get workspaces in a governance group description: | Gets all workspaces assigned to the governance group. **Note:** Postman-managed governance groups (`type: system`) are read-only through this API. Listing a system group's workspaces returns an HTTP `403 Forbidden` response. operationId: getGovernanceGroupWorkspaces tags: - API Governance - Governance Groups parameters: - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit-2' responses: '200': $ref: '#/components/responses/getGovernanceGroupWorkspaces' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/governanceGroupId' /governance-groups/{groupId}/bulk-workspaces: post: summary: Assign and unassign workspaces description: | Assigns workspaces to and unassigns workspaces from a governance group. On success, this returns an empty object. **Note:** - Postman-managed governance groups (`type: system`) are read-only through this API. Bulk workspace assignments against a system group return an HTTP `403 Forbidden` response. - If any workspace in the batch can't be applied, no changes are made and the entire request fails with an HTTP `409 Conflict` response. operationId: updateGovernanceGroupWorkspaces tags: - API Governance - Governance Groups requestBody: $ref: '#/components/requestBodies/updateGovernanceGroupWorkspaces' responses: '200': $ref: '#/components/responses/updateGovernanceGroupWorkspaces' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '409': $ref: '#/components/responses/workspaceAssignment409Conflict' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/governanceGroupId' /groups: get: summary: Get all groups description: Gets all of a team's Postman [groups](https://learning.postman.com/docs/collaborating-in-postman/user-groups/). operationId: getGroups tags: - Groups responses: '200': $ref: '#/components/responses/getGroups' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '500': $ref: '#/components/responses/common500Error' /groups/{groupId}: get: summary: Get a group description: Gets information about a Postman [user group](https://learning.postman.com/docs/collaborating-in-postman/user-groups/). operationId: getGroup tags: - Groups responses: '200': $ref: '#/components/responses/getGroup' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/groupId' /import/openapi: post: summary: Import an OpenAPI definition description: | Imports an OpenAPI definition into Postman as a new [Postman Collection](https://learning.postman.com/docs/getting-started/creating-the-first-collection/). **Note:** - This endpoint has a rate limit of **10 requests per 10 seconds**. - The Postman web app does not support the `file` input method type. - If you do not include the `workspace` query parameter, the system imports the definition into the oldest personal Internal workspace you own. tags: - Import requestBody: $ref: '#/components/requestBodies/importOpenApiDefinition' responses: '200': $ref: '#/components/responses/importOpenApiDefinition' '400': $ref: '#/components/responses/import400Error' '401': $ref: '#/components/responses/common401Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceQueryTrue' /invitations: post: summary: Manage Partner Workspace invites description: | Manages invitations and access to your team's [Partner Workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/manage/). You can use this endpoint to: - Send Partner Workspace invitations to the given email addresses. Users who already exist in the partnership are added directly, while new users receive an invitation email. - Remove partners from a workspace. - Remove partners from a partnership and all of its workspaces. **Note:** - Partner Workspaces are available on the Postman **Team** and **Enterprise** [plans](https://www.postman.com/pricing/). - This endpoint requires the following [roles](https://learning.postman.com/docs/administration/roles-and-permissions/), based on your plan: - **Team** — Requires the **Workspace Editor** role to invite or remove partners from workspaces. The **Admin** role is required for removing partners from all workspaces. - **Enterprise** — The **Partner Manager** role can perform all operations. The **Workspace Editor** role and **Admin** roles have the same permissions on this plan as they do on the Team plan. It's recommended to use the **Partner Manager** role if you're on an **Enterprise** plan. operationId: managePartnerWorkspaceInvites x-postman-plan: Enterprise, Team tags: - Workspaces - Partner Workspaces requestBody: $ref: '#/components/requestBodies/managePartnerWorkspaceInvites' responses: '200': $ref: '#/components/responses/managePartnerWorkspaceInvitesResponse' '400': $ref: '#/components/responses/managePartnerWorkspaceInvites400Error' '401': $ref: '#/components/responses/managePartnerWorkspaceInvites401Error' '403': $ref: '#/components/responses/managePartnerWorkspaceInvites403Error' '404': $ref: '#/components/responses/managePartnerWorkspaceInvites404Error' '500': $ref: '#/components/responses/common500Error' /me: get: summary: Get authenticated user description: | Gets information about the authenticated user. **Note:** - This API returns a different response for users with the [Guest and Partner roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles). - The `flow_count` response only returns for users on [Free plans](https://www.postman.com/pricing/). operationId: getAuthenticatedUser tags: - Users responses: '200': $ref: '#/components/responses/getAuthenticatedUser' '401': $ref: '#/components/responses/common401Error' '500': $ref: '#/components/responses/common500Error' /mocks: get: summary: Get all mock servers description: | Gets all active 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. operationId: getMocks tags: - Mocks responses: '200': $ref: '#/components/responses/getMocks' '401': $ref: '#/components/responses/common401Error' '500': $ref: '#/components/responses/mock500Error' parameters: - $ref: '#/components/parameters/teamIdResultsQuery' - $ref: '#/components/parameters/workspaceResultsQuery' post: summary: Create a mock server description: | Creates a mock server in a collection. **Note:** - You cannot create mocks for collections added to an API definition. - If you do not include the `workspaceId` query parameter, the system creates the mock server in the oldest personal Internal workspace you own. operationId: createMock tags: - Mocks requestBody: $ref: '#/components/requestBodies/createMock' responses: '200': $ref: '#/components/responses/mockCreateUpdate' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '500': $ref: '#/components/responses/mock500Error' parameters: - $ref: '#/components/parameters/workspaceQueryTrue' /mocks/{mockId}: get: summary: Get a mock server description: Gets information about a mock server. operationId: getMock tags: - Mocks responses: '200': $ref: '#/components/responses/getMock' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/mock404Error' '500': $ref: '#/components/responses/mock500Error' put: summary: Update a mock server description: Updates a mock server's properties, such as its name or collection. operationId: updateMock tags: - Mocks requestBody: $ref: '#/components/requestBodies/updateMock' responses: '200': $ref: '#/components/responses/mockCreateUpdate' '400': $ref: '#/components/responses/mock400Error' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/mock404Error' '500': $ref: '#/components/responses/mock500Error' delete: summary: Delete a mock server description: Deletes a mock server. operationId: deleteMock tags: - Mocks responses: '200': $ref: '#/components/responses/deleteMock' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/mock404Error' '500': $ref: '#/components/responses/mock500Error' parameters: - $ref: '#/components/parameters/mockId' /mocks/{mockId}/call-logs: get: summary: Get a mock server's call logs description: | 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. **Note:** Call logs have a retention period based on your [Postman plan](https://www.postman.com/pricing/#mock-calls). For more information, see [this article](https://support.postman.com/hc/en-us/articles/21219973964951-I-can-t-see-my-mock-server-logs-history) in the [Postman Support Center](https://support.postman.com/). operationId: getMockCallLogs tags: - Mocks responses: '200': $ref: '#/components/responses/getMockCallLogs' '400': $ref: '#/components/responses/mock400Error' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/mock404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/limitDefault100' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/until' - $ref: '#/components/parameters/since' - $ref: '#/components/parameters/mockResponseStatusCode' - $ref: '#/components/parameters/mockResponseType' - $ref: '#/components/parameters/mockRequestMethod' - $ref: '#/components/parameters/mockRequestPath' - $ref: '#/components/parameters/mockSortServedAt' - $ref: '#/components/parameters/direction' - $ref: '#/components/parameters/mockInclude' parameters: - $ref: '#/components/parameters/mockId' /mocks/{mockId}/publish: post: summary: Publish a mock server description: Publishes a mock server. Publishing a mock server sets its **Access Control** configuration setting to public. operationId: publishMock tags: - Mocks responses: '200': $ref: '#/components/responses/publishMock' '400': $ref: '#/components/responses/mock400Error' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/mock404Error' '500': $ref: '#/components/responses/mock500Error' parameters: - $ref: '#/components/parameters/mockId' /mocks/{mockId}/unpublish: delete: summary: Unpublish a mock server description: Unpublishes a mock server. Unpublishing a mock server sets its **Access Control** configuration setting to private. operationId: unpublishMock tags: - Mocks responses: '200': $ref: '#/components/responses/unpublishMock' '400': $ref: '#/components/responses/mock400Error' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/mock404Error' '500': $ref: '#/components/responses/mock500Error' parameters: - $ref: '#/components/parameters/mockId' /mocks/{mockId}/server-responses: get: summary: Get all server responses description: Gets all of a mock server's server responses. operationId: getMockServerResponses tags: - Mocks responses: '200': $ref: '#/components/responses/getMockServerResponses' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/mockServerResponse404Error' '500': $ref: '#/components/responses/common500Error' post: summary: Create a server response description: | 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. operationId: createMockServerResponse tags: - Mocks requestBody: $ref: '#/components/requestBodies/createMockServerResponse' responses: '200': $ref: '#/components/responses/mockServerResponse' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/mockServerResponse404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/mockId' /mocks/{mockId}/server-responses/{serverResponseId}: get: summary: Get a server response description: Gets information about a server response. operationId: getMockServerResponse tags: - Mocks responses: '200': $ref: '#/components/responses/mockServerResponse' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/mockServerResponse404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/mockId' - $ref: '#/components/parameters/serverResponseId' put: summary: Update a server response description: Updates a server response. operationId: updateMockServerResponse tags: - Mocks requestBody: $ref: '#/components/requestBodies/updateMockServerResponse' responses: '200': $ref: '#/components/responses/mockServerResponse' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/mockServerResponse404Error' '500': $ref: '#/components/responses/common500Error' delete: summary: Delete a server response description: Deletes a mock server's server response. operationId: deleteMockServerResponse tags: - Mocks responses: '200': $ref: '#/components/responses/deleteMockServerResponse' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/mockServerResponse404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/mockId' - $ref: '#/components/parameters/serverResponseId' /monitors: get: summary: Get all monitors description: Gets all monitors. operationId: getMonitors tags: - Monitors responses: '200': $ref: '#/components/responses/getMonitors' '400': $ref: '#/components/responses/monitors400Errors' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/monitors404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceResultsQuery' - $ref: '#/components/parameters/active' - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/collectionUidQuery-2' - $ref: '#/components/parameters/environmentUidQuery' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limitDefault25' post: summary: Create a monitor description: | Creates a monitor. **Note:** - You cannot create monitors for collections added to an API definition. - If you do not pass the `workspace` query parameter, the system creates the monitor in the oldest personal Internal workspace you own. operationId: createMonitor tags: - Monitors requestBody: $ref: '#/components/requestBodies/createMonitor' responses: '200': $ref: '#/components/responses/createMonitor' '400': $ref: '#/components/responses/monitors400Errors' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceQueryTrue' /monitors/{monitorId}: get: summary: Get a monitor description: Gets information about a monitor. operationId: getMonitor tags: - Monitors responses: '200': $ref: '#/components/responses/getMonitor' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/monitors404Error' '500': $ref: '#/components/responses/common500Error' put: summary: Update a monitor description: Updates a monitor's [configurations](https://learning.postman.com/docs/monitoring-your-api/setting-up-monitor/#configure-a-monitor). operationId: updateMonitor tags: - Monitors requestBody: $ref: '#/components/requestBodies/updateMonitor' responses: '200': $ref: '#/components/responses/updateMonitor' '400': $ref: '#/components/responses/monitors400Errors' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/monitors404Error' '500': $ref: '#/components/responses/common500Error' delete: summary: Delete a monitor description: Deletes a monitor. operationId: deleteMonitor tags: - Monitors responses: '200': $ref: '#/components/responses/deleteMonitor' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/monitors404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/monitorId' /monitors/{monitorId}/run: post: summary: Run a monitor description: | Runs a monitor and returns its run results. **Note:** - If you pass the `async=true` query parameter, the response does not return the `stats`, `executions`, and `failures` responses. To get this information for an asynchronous run, call the GET `/monitors/{id}` endpoint. - If the call exceeds 300 seconds, the endpoint returns an HTTP `202 Accepted` response. Use the GET `/monitors/{id}` endpoint to check the run's status in the response's `lastRun` property. To avoid this, it is recommended that you include the `async=true` query parameter when using this endpoint. operationId: runMonitor tags: - Monitors responses: '200': $ref: '#/components/responses/runMonitor' '202': $ref: '#/components/responses/runMonitor202' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/monitors404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/monitorId' - $ref: '#/components/parameters/async' /network/private: get: summary: Get all workspaces description: Gets information workspaces added to your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). operationId: listPrivateNetworkWorkspaces x-postman-plan: Enterprise tags: - Private API Network responses: '200': $ref: '#/components/responses/getPanElements' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/elementTypeQuery' - $ref: '#/components/parameters/panElementName' - $ref: '#/components/parameters/panSummary' - $ref: '#/components/parameters/panElementDescription' - $ref: '#/components/parameters/since' - $ref: '#/components/parameters/until' - $ref: '#/components/parameters/panAddedBy' - $ref: '#/components/parameters/sortCreatedUpdatedAt' - $ref: '#/components/parameters/direction' - $ref: '#/components/parameters/createdBy' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limitDefault1000' - $ref: '#/components/parameters/panParentFolderId' post: summary: Add a workspace description: Publishes a workspace in your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). operationId: addWorkspaceToPrivateNetwork x-postman-plan: Enterprise tags: - Private API Network requestBody: $ref: '#/components/requestBodies/postPanElement' responses: '201': $ref: '#/components/responses/postPanElement' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/pan404Error' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' /network/private/workspace/{workspaceId}: delete: summary: Remove a workspace description: | Removes a workspace from your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). **Note:** Removing a workspace does not delete it. It only removes it from the Private API Network folder. operationId: removeWorkspaceFromPrivateNetwork x-postman-plan: Enterprise tags: - Private API Network responses: '200': $ref: '#/components/responses/deletePanElement' '400': $ref: '#/components/responses/pan400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/pan404Error' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' put: deprecated: true summary: Update an element or folder description: | **This endpoint is deprecated.** operationId: updatePanElementOrFolder x-postman-plan: Enterprise tags: - Private API Network requestBody: $ref: '#/components/requestBodies/updatePanElement' responses: '200': description: Successful Response '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/pan404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceId' /network/private/network-entity/request/all: get: summary: Get all add requests description: Gets all requests to add workspaces to your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). tags: - Private API Network operationId: listPrivateNetworkAddRequests x-postman-plan: Enterprise responses: '200': $ref: '#/components/responses/getAllPanAddElementRequests' '400': $ref: '#/components/responses/pan400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/sinceUrlEncode' - $ref: '#/components/parameters/untilUrlEncode' - $ref: '#/components/parameters/panRequestedBy' - $ref: '#/components/parameters/elementTypeQuery' - $ref: '#/components/parameters/panRequestStatus' - $ref: '#/components/parameters/panElementName' - $ref: '#/components/parameters/sortCreatedUpdatedAt' - $ref: '#/components/parameters/direction' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limitDefault1000' /network/private/network-entity/request/{requestId}: put: summary: Respond to an add request description: Responds to a user's request to add a workspace to your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). Only managers can approve or deny a request. Once approved, the workspace will appear in the team's Private API Network. tags: - Private API Network operationId: respondPrivateNetworkAddRequest x-postman-plan: Enterprise requestBody: $ref: '#/components/requestBodies/respondPanElementAddRequest' responses: '200': $ref: '#/components/responses/respondPanElementAddRequest' '400': $ref: '#/components/responses/pan400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/panRequestId' /oauth2/token: post: summary: Generate an OAuth Token description: | Generates an OAuth 2.0 access token for a client application using the `client_credentials` grant type. Use this endpoint with backend services or bots to authenticate and authorize API requests without user interaction. **Note:** This endpoint uses Basic Auth. You must pass a valid client ID and client secret for the username and password, respectively. operationId: generateOauthToken tags: - OAuth 2.0 requestBody: $ref: '#/components/requestBodies/generateOauthToken' responses: '200': $ref: '#/components/responses/generateOauthTokenResponse' '400': $ref: '#/components/responses/oauthToken400Error' '404': $ref: '#/components/responses/oauthToken404Error' '500': $ref: '#/components/responses/common500Error' security: - basicAuth: [] /oauth2/token/revoke: post: summary: Revoke an OAuth Token description: | Revokes an active OAuth 2.0 access token and prevents further use of it for authentication. Once revoked, the token can't be used for any API requests. **Note:** - Revocation of an OAuth token is immediate and can't be undone. - This request does not use any authorization. operationId: revokeOauthToken tags: - OAuth 2.0 requestBody: $ref: '#/components/requestBodies/revokeOauthToken' responses: '200': $ref: '#/components/responses/revokeOauthTokenResponse' '404': $ref: '#/components/responses/oauthToken404Error' '500': $ref: '#/components/responses/common500Error' security: - {} /packages: post: summary: Create a package description: Creates a package and its index script as a Postman Package Library resource. operationId: createPackage tags: - Packages requestBody: $ref: '#/components/requestBodies/createPackage' responses: '201': $ref: '#/components/responses/createPackageResponse' '400': $ref: '#/components/responses/packages400Error' '401': $ref: '#/components/responses/packages401Error' '403': $ref: '#/components/responses/packages403Error' '409': $ref: '#/components/responses/packages409Error' '429': $ref: '#/components/responses/packages429Error' '500': $ref: '#/components/responses/packages500Error' parameters: - $ref: '#/components/parameters/workspaceQueryTrue' get: summary: Get all packages description: | Gets all active packages available to the authenticated user. **Note:** Script content isn't included in response. operationId: getPackages tags: - Packages responses: '200': $ref: '#/components/responses/getPackages' '400': $ref: '#/components/responses/packages400Error' '401': $ref: '#/components/responses/packages401Error' '403': $ref: '#/components/responses/packages403Error' '429': $ref: '#/components/responses/packages429Error' '500': $ref: '#/components/responses/packages500Error' parameters: - $ref: '#/components/parameters/limitDefault100Max100' - $ref: '#/components/parameters/cursor' /packages/{packageId}: get: summary: Get a package description: Gets an active package's metadata and its current index script content. operationId: getPackage tags: - Packages responses: '200': $ref: '#/components/responses/getPackage' '400': $ref: '#/components/responses/packages400Error' '401': $ref: '#/components/responses/packages401Error' '403': $ref: '#/components/responses/packages403Error' '404': $ref: '#/components/responses/packages404Error' '429': $ref: '#/components/responses/packages429Error' '500': $ref: '#/components/responses/packages500Error' patch: summary: Update a package description: Updates a package's description and/or index script content. operationId: updatePackage tags: - Packages requestBody: $ref: '#/components/requestBodies/updatePackage' responses: '200': $ref: '#/components/responses/updatePackageResponse' '400': $ref: '#/components/responses/packages400Error' '401': $ref: '#/components/responses/packages401Error' '403': $ref: '#/components/responses/packages403Error' '404': $ref: '#/components/responses/packages404Error' '429': $ref: '#/components/responses/packages429Error' '500': $ref: '#/components/responses/packages500Error' delete: summary: Delete a package description: | Deletes the package and its associated index script content. On success, this returns an HTTP `204 No Content` response. **Note:** The endpoint returns an HTTP `204 No Content` response even if the package no longer exists. operationId: deletePackage tags: - Packages responses: '204': description: Package Deleted '400': $ref: '#/components/responses/packages400Error' '401': $ref: '#/components/responses/packages401Error' '403': $ref: '#/components/responses/packages403Error' '404': $ref: '#/components/responses/packages404Error' '429': $ref: '#/components/responses/packages429Error' '500': $ref: '#/components/responses/packages500Error' parameters: - $ref: '#/components/parameters/packageId' /postbot/generations/tool: post: deprecated: true summary: Generate a tool description: | **This endpoint is deprecated** Generates code for an AI agent tool using a collection and request from the Public API Network. For more information, see [**Tool Generation Demo**](http://postman.com/explore/toolgen) in Postman's Public API Network. ### Important - This endpoint has a rate limit of **300 calls every 3 hours**. This does not accrue Postbot usage. - This endpoint only supports public Postman Collections and requests. operationId: generateTool tags: - Postbot requestBody: $ref: '#/components/requestBodies/generateTool' responses: '200': $ref: '#/components/responses/generateTool' '400': $ref: '#/components/responses/postbot400Error' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' /pull-requests/{pullRequestId}: get: summary: Get a pull request description: 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. operationId: getPullRequest tags: - Pull Requests responses: '200': $ref: '#/components/responses/getPullRequest' '403': $ref: '#/components/responses/pullRequest403Error' '500': $ref: '#/components/responses/common500Error' put: summary: Update a pull request description: Updates an open pull request. operationId: updatePullRequest tags: - Pull Requests requestBody: $ref: '#/components/requestBodies/pullRequestUpdate' responses: '200': $ref: '#/components/responses/pullRequestUpdate' '403': $ref: '#/components/responses/pullRequest403Error' '409': $ref: '#/components/responses/pullRequest409Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/pullRequestId' /pull-requests/{pullRequestId}/tasks: post: summary: Review a pull request description: Updates the [review](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/reviewing-pull-requests/) status of a pull request. operationId: reviewPullRequest tags: - Pull Requests requestBody: $ref: '#/components/requestBodies/pullRequestReview' responses: '200': $ref: '#/components/responses/pullRequestReviewResponse' '400': $ref: '#/components/responses/pullRequest400Error' '403': $ref: '#/components/responses/pullRequest403Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/pullRequestId' /runners/{runnerId}/instances: get: summary: Get all runner instances description: | Gets all instances of the runner polling Postman for upcoming monitor runs. Instances are runner executions that share the same runner ID and key. **Note:** You can get a runner's ID in the Postman UI if you have an Admin or Super Admin role. To do this, click **Team > Team Settings** in Postman, then click **Runners**. Click the runner you want to get the ID of, then copy its ID from the URL. tags: - Monitors - Runners - Runner Instances operationId: getRunnerInstances responses: '200': $ref: '#/components/responses/getRunnerInstances' '400': $ref: '#/components/responses/runner400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/runner404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/limitDefault25' - $ref: '#/components/parameters/cursor' parameters: - $ref: '#/components/parameters/runnerId' /runners/{runnerId}/metrics: get: summary: Get runner metrics description: | Gets the Postman server-side metrics for a runner instance. Metrics include information such as monitor run queues and last polling date. **Note:** You can get a runner's ID in the Postman UI if you have a Team Admin or Super Admin role. To do this, click **Team > Team Settings** in Postman, then click **Runners**. Click the runner you want to get the ID of, then copy its ID from the URL. tags: - Monitors - Runners - Runner Metrics operationId: getRunnerMetrics responses: '200': $ref: '#/components/responses/getRunnerMetrics' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/runner404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/runnerId' /rulesets: get: summary: Get all rulesets description: Gets a list of the team's rulesets. The response includes both team-owned rulesets (`custom`) and Postman-managed system rulesets (`system`). This endpoint doesn't include ruleset content. operationId: getAllRulesets tags: - API Governance - Rulesets parameters: - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit-2' responses: '200': $ref: '#/components/responses/getAllRulesets' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '500': $ref: '#/components/responses/common500Error' post: summary: Create a ruleset description: Creates a new ruleset for the team. operationId: createRuleset tags: - API Governance - Rulesets requestBody: $ref: '#/components/requestBodies/createRuleset' responses: '201': $ref: '#/components/responses/createRuleset' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '409': $ref: '#/components/responses/ruleset409Conflict' '500': $ref: '#/components/responses/common500Error' /rulesets/{rulesetId}: get: summary: Get a ruleset description: | Gets information about a ruleset. By default, the response only returns the ruleset's metadata. To include ruleset contents in the response, pass the `include` query parameter. operationId: getRuleset tags: - API Governance - Rulesets parameters: - $ref: '#/components/parameters/apiGovernanceInclude' responses: '200': $ref: '#/components/responses/getRuleset' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '500': $ref: '#/components/responses/common500Error' patch: summary: Update a ruleset description: | Updates a ruleset. Only the fields present in the request body are updated. If `content` is provided, it replaces the entire contents of the ruleset. **Note:** Postman-managed system rulesets (`type: system`) can't be updated and return an HTTP `403 Forbidden` response. operationId: updateRuleset tags: - API Governance - Rulesets requestBody: $ref: '#/components/requestBodies/updateRuleset' responses: '200': $ref: '#/components/responses/updateRuleset' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '409': $ref: '#/components/responses/ruleset409Conflict' '500': $ref: '#/components/responses/common500Error' delete: summary: Delete a ruleset description: | Deletes a ruleset. On success, this returns an HTTP `204 No Content` response. **Note:** Postman-managed system rulesets (`type: system`) can't be deleted and return an HTTP `403 Forbidden` response. operationId: deleteRuleset tags: - API Governance - Rulesets responses: '204': description: Ruleset deleted. '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/rulesetId' /rulesets/{rulesetId}/assignments: get: summary: Get ruleset assignments description: Gets a ruleset's governance group assignments. operationId: getRulesetAssignments tags: - API Governance - Rulesets responses: '200': $ref: '#/components/responses/getRulesetAssignments' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '500': $ref: '#/components/responses/common500Error' post: summary: Assign a ruleset description: Assigns a ruleset to a governance group. operationId: createRulesetAssignment tags: - API Governance - Rulesets requestBody: $ref: '#/components/requestBodies/createRulesetAssignment' responses: '201': $ref: '#/components/responses/createRulesetAssignment' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '409': $ref: '#/components/responses/rulesetAssignment409Conflict' '500': $ref: '#/components/responses/common500Error' delete: summary: Delete a ruleset assignment description: Unassigns a ruleset from a governance group. operationId: deleteRulesetAssignment tags: - API Governance - Rulesets parameters: - $ref: '#/components/parameters/targetTypeQuery' - $ref: '#/components/parameters/targetIdQuery' responses: '200': $ref: '#/components/responses/deleteRulesetAssignment' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/rulesetId' /secret-types: get: summary: Get secret types description: Gets the metadata of the secret types supported by Postman's [Secret Scanner](https://learning.postman.com/docs/administration/secret-scanner/). You can use a secret type's ID in the response to query data with the POST `/detected-secrets/{secretId}` endpoint. operationId: getSecretTypes x-postman-plan: Enterprise tags: - Secret Scanner responses: '200': $ref: '#/components/responses/getSecretTypes' '401': $ref: '#/components/responses/secretScanner401Error' '403': $ref: '#/components/responses/secretScanner403Error' '500': $ref: '#/components/responses/secretScanner500Error' /security/api-validation: post: summary: API definition security validation deprecated: true description: | **This endpoint is deprecated.** Performs an analysis on the given definition and returns any issues based on your [predefined rulesets](https://learning.postman.com/docs/api-governance/configurable-rules/configurable-rules-overview/). 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. **Note:** - The maximum allowed size of the definition is 10 MB. - You must [import and enable](https://learning.postman.com/docs/api-governance/configurable-rules/configuring-api-governance-rules/) Postman's [OWASP security rules](https://postman.postman.co/api-governance/libraries/postman_owasp/view) for this endpoint to return any security rule violations. operationId: schemaSecurityValidation tags: - API Governance requestBody: $ref: '#/components/requestBodies/schemaSecurityValidation' responses: '200': $ref: '#/components/responses/schemaSecurityValidation' '400': $ref: '#/components/responses/apiSecurity400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '500': $ref: '#/components/responses/common500Error' /tags/{slug}/entities: get: summary: Get elements by tag description: | Gets Postman elements (entities) by a given tag. Tags enable you to organize and search [workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#tagging-a-workspace), [APIs](https://learning.postman.com/docs/designing-and-developing-your-api/managing-apis/#tagging-apis), and [collections](https://learning.postman.com/docs/collections/using-collections/#tagging-a-collection) that contain shared tags. **Note:** Tagging is available on Postman [**Solo**, **Team**, and **Enterprise** plans](https://www.postman.com/pricing/). operationId: getTaggedEntities x-postman-plan: Enterprise tags: - Tags responses: '200': $ref: '#/components/responses/getTaggedEntities' '400': $ref: '#/components/responses/tagElement400Error' '401': $ref: '#/components/responses/tag401Error' '403': $ref: '#/components/responses/tag403Error' '404': $ref: '#/components/responses/tag404Error' '500': $ref: '#/components/responses/tag500Error' parameters: - $ref: '#/components/parameters/tagsSlug' - $ref: '#/components/parameters/tagsEntitiesLimit' - $ref: '#/components/parameters/tagsEntitiesDirection' - $ref: '#/components/parameters/tagsCursor' - $ref: '#/components/parameters/tagsEntityType' /scim/v2/Groups: get: summary: Get all groups description: Gets information about all Postman team members. operationId: getScimGroupResources x-postman-plan: Enterprise tags: - SCIM - Group Provisioning responses: '200': $ref: '#/components/responses/getScimGroupResources' '400': $ref: '#/components/responses/scim400ErrorInvalidFilter' '401': $ref: '#/components/responses/scim401Error' '403': $ref: '#/components/responses/scim403Error' '500': $ref: '#/components/responses/scimGroup500Error' security: - scimApiKey: [] parameters: - $ref: '#/components/parameters/startIndex' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/scimGroupFilter' post: summary: Create a group description: | Creates a new user group in Postman and creates a new account for each group member. Each account is added to your Postman team and authentication is activated for each user. If an existing Postman account uses an email that matches a group member's email ID, an [email invite](https://postman.postman.co/docs/administration/managing-your-team/managing-your-team/#invites) to join your Postman 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 Postman](https://learning.postman.com/docs/administration/managing-your-team/managing-your-team/#managing-team-roles). operationId: createScimGroup x-postman-plan: Enterprise tags: - SCIM - Group Provisioning requestBody: $ref: '#/components/requestBodies/createScimGroup' responses: '201': $ref: '#/components/responses/createScimGroup' '400': $ref: '#/components/responses/scim400ErrorInvalidSyntax' '401': $ref: '#/components/responses/scim401Error' '403': $ref: '#/components/responses/scim403Error' '409': $ref: '#/components/responses/scim409Error' '500': $ref: '#/components/responses/scimUpdateGroup500Error' security: - scimApiKey: [] /scim/v2/Groups/{groupId}: get: summary: Get a group description: Gets information about a Postman group within the team. operationId: getScimGroupResource x-postman-plan: Enterprise tags: - SCIM - Group Provisioning responses: '200': $ref: '#/components/responses/getScimGroupResource' '400': $ref: '#/components/responses/scim400Error' '401': $ref: '#/components/responses/scim401Error' '403': $ref: '#/components/responses/scim403Error' '404': $ref: '#/components/responses/scimGroup404Error' '500': $ref: '#/components/responses/scim500Error' security: - scimApiKey: [] patch: summary: Update a group description: | Updates a group's information. Using this endpoint you can: - Update a group's name. - Add or remove members from a Postman group. operationId: scimUpdateGroup x-postman-plan: Enterprise tags: - SCIM - Group Provisioning requestBody: $ref: '#/components/requestBodies/scimUpdateGroup' responses: '200': $ref: '#/components/responses/scimUpdateGroup' '400': $ref: '#/components/responses/scim400ErrorInvalidSyntax' '401': $ref: '#/components/responses/scim401Error' '403': $ref: '#/components/responses/scim403Error' '404': $ref: '#/components/responses/scimGroup404Error' '500': $ref: '#/components/responses/scim500Error' security: - scimApiKey: [] delete: summary: Delete a group description: | Deletes a group in Postman. On success, this returns an HTTP `204 No Content` response. User accounts that were in the deleted group are deactivated in Postman 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 Postman support](https://www.postman.com/support/). operationId: deleteScimGroup x-postman-plan: Enterprise tags: - SCIM - Group Provisioning responses: '204': description: Group Deleted '400': $ref: '#/components/responses/scim400Error' '401': $ref: '#/components/responses/scim401Error' '403': $ref: '#/components/responses/scim403Error' '404': $ref: '#/components/responses/scimGroup404Error' '500': $ref: '#/components/responses/scim500Error' security: - scimApiKey: [] parameters: - $ref: '#/components/parameters/scimGroupId' /scim/v2/ResourceTypes: get: summary: Get resource types description: Gets all the resource types supported by Postman's SCIM API. operationId: getScimResourceTypes x-postman-plan: Enterprise tags: - SCIM responses: '200': $ref: '#/components/responses/getScimResourceTypes' '401': $ref: '#/components/responses/common401Error' '500': $ref: '#/components/responses/scim500Error' security: - scimApiKey: [] /scim/v2/ServiceProviderConfig: get: summary: Get service provider configuration description: Gets the Postman SCIM API configuration information. This includes a list of supported operations. operationId: getScimServiceProviderConfig x-postman-plan: Enterprise tags: - SCIM responses: '200': $ref: '#/components/responses/getScimServiceProviderConfig' '401': $ref: '#/components/responses/scim401Error' '500': $ref: '#/components/responses/scim500Error' security: - scimApiKey: [] /scim/v2/Users: get: summary: Get all users description: Gets information about all Postman team members. operationId: getScimUserResources x-postman-plan: Enterprise tags: - SCIM - User Provisioning responses: '200': $ref: '#/components/responses/getScimUserResources' '400': $ref: '#/components/responses/scim400Error' '401': $ref: '#/components/responses/scim401Error' '403': $ref: '#/components/responses/scim403Error' '500': $ref: '#/components/responses/scim500Error' security: - scimApiKey: [] parameters: - $ref: '#/components/parameters/startIndex' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/scimUserFilter' post: summary: Create a user description: | Creates a new user account in Postman and adds the user to your organization's Postman team. - If the account does not exist, this also activates the user so they can authenticate in to your Postman team. - If an account matching the email ID exists, the user receives [email invite](https://learning.postman.com/docs/administration/managing-your-team/manage-team-members/#manage-invites) to join the Postman team. The user joins the team when they accept the invite. - If the user's email domain matches your team's verified domains, the user is immediately added to the team. By default, the system assigns new users the developer role. You can [update user roles in Postman](https://learning.postman.com/docs/administration/managing-your-team/manage-team-members/#manage-team-roles). **Note:** - Users must join the team before you can assign them to any groups. - If the user is a member of a different team during SCIM provisioning and their email domain is **not** verified with your Postman team, then the user is **not** provisioned. The endpoint returns an HTTP `409 Conflict` response. operationId: createScimUser x-postman-plan: Enterprise tags: - SCIM - User Provisioning requestBody: $ref: '#/components/requestBodies/createScimUser' responses: '201': $ref: '#/components/responses/createScimUser' '400': $ref: '#/components/responses/scim400ErrorInvalidSyntax' '401': $ref: '#/components/responses/scim401Error' '403': $ref: '#/components/responses/scim403Error' '409': $ref: '#/components/responses/scim409Error' '500': $ref: '#/components/responses/scim500Error' security: - scimApiKey: [] /scim/v2/Users/{userId}: get: summary: Get a user description: Gets information about a Postman team member. operationId: getScimUserResource x-postman-plan: Enterprise tags: - SCIM - User Provisioning responses: '200': $ref: '#/components/responses/scimUserResourceResponse' '400': $ref: '#/components/responses/scim400Error' '401': $ref: '#/components/responses/scim401Error' '403': $ref: '#/components/responses/scim403Error' '404': $ref: '#/components/responses/scim404Error' '500': $ref: '#/components/responses/scim500ErrorUser' security: - scimApiKey: [] put: summary: Update a user description: | Updates a user in Postman. **Reactivating a user** By setting the `active` property from `false` to `true`, this reactivates an account. This allows the account to authenticate in to Postman and adds the account back on to your Postman team. operationId: updateScimUser x-postman-plan: Enterprise tags: - SCIM - User Provisioning requestBody: $ref: '#/components/requestBodies/updateScimUser' responses: '200': $ref: '#/components/responses/scimUserResourceResponse' '400': $ref: '#/components/responses/scimUpdateUser400Error' '401': $ref: '#/components/responses/scim401Error' '403': $ref: '#/components/responses/scim403Error' '404': $ref: '#/components/responses/scim404Error' '500': $ref: '#/components/responses/scim500Error' security: - scimApiKey: [] patch: summary: Update a user description: | Updates a user in Postman. **Reactivating a user** By setting the `active` property from `false` to `true`, this reactivates an account. This allows the account to authenticate in to Postman and adds the account back on to your Postman team. operationId: updateScimUserPatch x-postman-plan: Enterprise tags: - SCIM - User Provisioning requestBody: $ref: '#/components/requestBodies/updateScimUserPatch' responses: '200': $ref: '#/components/responses/scimUserResourceResponse' '400': $ref: '#/components/responses/scimUpdateUser400Error' '401': $ref: '#/components/responses/scim401Error' '403': $ref: '#/components/responses/scim403Error' '404': $ref: '#/components/responses/scim404Error' '500': $ref: '#/components/responses/scim500Error' security: - scimApiKey: [] parameters: - $ref: '#/components/parameters/scimUserId' /sdks: post: summary: Generate an SDK description: | Creates an asynchronous generation job for a single SDK (in one language) from a collection or specification. To get the status of an SDK's generation, use the GET `/sdks/{sdkId}` endpoint and track its `buildStatus`. When the status is the `succeeded` value, the SDK is ready to download. You can also use the URL in the POST response's `Location` header. **Note:** The request body is determined by the given `language` value, so only provide the properties relevant to that language's SDK. operationId: createSdk x-postman-plan: Enterprise and Team tags: - SDKs requestBody: $ref: '#/components/requestBodies/createSdk' responses: '202': $ref: '#/components/responses/createSdk' '400': $ref: '#/components/responses/sdk400ErrorInvalidCreateRequest' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '422': $ref: '#/components/responses/sdk422Error' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' get: summary: Get all SDKs description: | Lists all SDKs the authenticated user has access to. **Note:** - Use the `sdkIds` parameter to get the generation build status of multiple SDKs in a single call. - When you pass the `sdkIds` value, other filters are ignored and the response contains only the accessible SDKs from this list. operationId: getSdks x-postman-plan: Enterprise and Team tags: - SDKs parameters: - $ref: '#/components/parameters/sdkWorkspaceId' - $ref: '#/components/parameters/sdkIds' - $ref: '#/components/parameters/sdkBuildStatusFilter' - $ref: '#/components/parameters/sdkLanguageFilter' - $ref: '#/components/parameters/sdkSourceId' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limitDefault25' responses: '200': $ref: '#/components/responses/getSdks' '400': $ref: '#/components/responses/sdk400ErrorInvalidListQuery' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' /sdks/{sdkId}: get: summary: Get an SDK description: Returns information about the SDK, including the current build job status. operationId: getSdk x-postman-plan: Enterprise and Team tags: - SDKs responses: '200': $ref: '#/components/responses/getSdk' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' delete: summary: Delete an SDK description: | Deletes an SDK record and its stored archive. On success, this returns a `204 No Content` response. **Note:** You can't use this endpoint to cancel a generation job that's still in progress. operationId: deleteSdk x-postman-plan: Enterprise and Team tags: - SDKs responses: '204': description: Deleted '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '409': $ref: '#/components/responses/sdk409Error' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/sdkId' /sdks/{sdkId}/downloads: get: summary: Get an SDK's download URL description: | Gets a short-lived signed URL for the generated SDK archive (zip). The generated URL is created on demand and expires within a few minutes. **Note:** The API doesn't stream the archive directly to keep responses small and predictable. Use the returned URL to download the SDK zip file. operationId: getSdkDownloadUrl x-postman-plan: Enterprise and Team tags: - SDKs responses: '200': $ref: '#/components/responses/getSdkDownloadUrl' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '409': $ref: '#/components/responses/sdk409Error' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/sdkId' /sdk-git-connections: get: summary: Get all SDK Git connections description: Gets all Git repository connections the authenticated user has access to in the given workspace. Each connection links one Postman Collection or specification and one SDK language to a target Git repository. operationId: getSdkGitConnections x-postman-plan: Enterprise and Team tags: - SDKs - SDK Git Connections parameters: - $ref: '#/components/parameters/sdkGitConnectionWorkspaceId' - $ref: '#/components/parameters/sdkSourceId' - $ref: '#/components/parameters/sdkLanguageFilter' - $ref: '#/components/parameters/sdkGitConnectionStatusFilter' - $ref: '#/components/parameters/sdkGitConnectionRepositoryUrl' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limitDefault25' responses: '200': $ref: '#/components/responses/getSdkGitConnections' '400': $ref: '#/components/responses/sdkGitConnection400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' post: summary: Connect a Git repository to an SDK description: | Connects a Postman source element (collection or specification) to a Git repository for one SDK language. This creates a new connection in the `active` state. **Note:** - Each source and language pair maps to a single connection. If a connection already exists for the pair, this returns `409 Conflict` response. - To update an existing connection, use the PUT `/sdk-git-connections/{sdkGitConnectionId}` endpoint. - The `autoUpdatePullRequestsEnabled` property is only available to **Enterprise** plan users. If the user is on a **Team** plan, this value is always `false`. operationId: createSdkGitConnection x-postman-plan: Enterprise and Team tags: - SDKs - SDK Git Connections requestBody: $ref: '#/components/requestBodies/createSdkGitConnection' responses: '201': $ref: '#/components/responses/createSdkGitConnectionResponse' '400': $ref: '#/components/responses/sdkGitConnection400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '409': $ref: '#/components/responses/sdk409Error' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' /sdk-git-connections/{sdkGitConnectionId}: get: summary: Get an SDK Git connection description: Gets information about an SDK's Git connection. The response includes the SDK currently sent to the targetBranch and the most recent SDK-update pull request. operationId: getSdkGitConnection x-postman-plan: Enterprise and Team tags: - SDKs - SDK Git Connections responses: '200': $ref: '#/components/responses/getSdkGitConnection' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' put: summary: Update an SDK Git connection description: | Updates the Git connection's lifecycle status: - `active` — Connects or reconnects the repository. All auto-update pull requests resume. - `disconnected` — Disconnects the repository, and no further auto-update pull requests are opened. The historical pull request record is preserved and remains queryable. **Note:** - The `autoUpdatePullRequestsEnabled` property is only available to **Enterprise** plan users and defaults to `true`. If the user is on a **Team** plan, this value is always `false`. - This action is idempotent. Setting the fields to their current values is a no-op and still returns the connection. - The `inaccessible` status is system-determined and can't be set with this endpoint. operationId: updateSdkGitConnection x-postman-plan: Enterprise and Team tags: - SDKs - SDK Git Connections requestBody: $ref: '#/components/requestBodies/updateSdkGitConnection' responses: '200': $ref: '#/components/responses/updateSdkGitConnectionResponse' '400': $ref: '#/components/responses/sdkGitConnection400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '422': $ref: '#/components/responses/sdk422Error' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/sdkGitConnectionId' /sdk-git-connections/{sdkGitConnectionId}/pull-requests: get: summary: Get an SDK Git connection's pull requests description: | Lists all SDK update pull requests for the Git connection, in order of newest first by its `updatedAt` property. **Note:** Direct push requests to the base branch are not returned in the response if a Git connection is configured to push only some changes directly to a base branch. operationId: getSdkGitConnectionPullRequests x-postman-plan: Enterprise and Team tags: - SDKs - SDK Git Connections parameters: - $ref: '#/components/parameters/sdkGitConnectionPRStatusFilter' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limitDefault25' responses: '200': $ref: '#/components/responses/getSdkGitConnectionPullRequests' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '429': $ref: '#/components/responses/common429Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/sdkGitConnectionId' /search: post: summary: Search Postman resources description: | Searches Postman for resources such as workspaces, collections, requests, and other resource types. You can filter results by ownership, visibility, tags, and other criteria. **Note:** If you call this endpoint without an API key, the response only returns publicly-available resources. operationId: searchPostmanResources tags: - Search requestBody: $ref: '#/components/requestBodies/searchPostmanResources' responses: '200': $ref: '#/components/responses/searchPostmanResourcesResponse' '400': $ref: '#/components/responses/searchPostman400Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/limitDefault10Max25' - $ref: '#/components/parameters/cursor' /specs: get: summary: Get all specs description: Gets all API specifications in a workspace. tags: - Specs operationId: getAllSpecs parameters: - $ref: '#/components/parameters/workspaceIdQueryTrue' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' responses: '200': $ref: '#/components/responses/getAllSpecs' '400': $ref: '#/components/responses/apiSpec400Error' '401': $ref: '#/components/responses/apiSpec401Error' '403': $ref: '#/components/responses/apiSpec403Error' '500': $ref: '#/components/responses/common500Error' post: summary: Create a spec description: | Creates an API specification in Postman's [Spec Hub](https://learning.postman.com/docs/design-apis/specifications/overview/). Specifications can be single or multi-file. **Note:** - Postman supports OpenAPI (2.0, 3.0, and 3.1), AsyncAPI (2.0 and 3.0), protobuf (2 and 3), GraphQL, and Smithy specifications. - If the file path contains a `/` (forward slash) character, then a folder is created. For example, if the path is the `components/schemas.json` value, then a `components` folder is created with the `schemas.json` file inside. - Multi-file specifications can only have one root file. - Files cannot exceed a maximum of 12 MB in size. tags: - Specs operationId: createSpec parameters: - $ref: '#/components/parameters/workspaceIdQueryTrue' requestBody: $ref: '#/components/requestBodies/createSpec' responses: '201': $ref: '#/components/responses/createSpecResponse' '400': $ref: '#/components/responses/apiSpec400Error' '401': $ref: '#/components/responses/apiSpec401Error' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/workspace404Error' '500': $ref: '#/components/responses/common500Error' /specs/{specId}: get: summary: Get a spec description: Gets information about an API specification. tags: - Specs operationId: getSpec responses: '200': $ref: '#/components/responses/getSpec' '401': $ref: '#/components/responses/apiSpec401Error' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '500': $ref: '#/components/responses/common500Error' delete: summary: Delete a spec description: Deletes an API specification. On success, this returns an HTTP `204 No Content` response. tags: - Specs operationId: deleteSpec responses: '204': description: No Content '401': $ref: '#/components/responses/apiSpec401Error' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '500': $ref: '#/components/responses/common500Error' patch: summary: Update a spec's properties description: Updates an API specification's properties, such as its name. tags: - Specs operationId: updateSpecProperties requestBody: $ref: '#/components/requestBodies/updateSpecProperties' responses: '200': $ref: '#/components/responses/updateSpecPropertiesResponse' '400': $ref: '#/components/responses/apiSpec400Error' '401': $ref: '#/components/responses/apiSpec401Error' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/specId' /specs/{specId}/collections/{collectionId}/sync-options: patch: summary: Update spec sync options description: Updates the [sync options](https://learning.postman.com/docs/design-apis/specifications/generate-collections/#configure-sync-settings) for a specification's generated collection. tags: - Specs operationId: updateSpecSyncOptions requestBody: $ref: '#/components/requestBodies/updateSpecSyncOptions' responses: '200': $ref: '#/components/responses/updateSpecSyncOptionsResponse' '400': $ref: '#/components/responses/apiSpecSyncOptions400Error' '401': $ref: '#/components/responses/apiSpecSyncOptions401Error' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/specId' - $ref: '#/components/parameters/collectionId' /specs/{specId}/definitions: get: summary: Get a spec's definition description: Gets the complete contents of an OpenAPI or AsyncAPI specification's definition. tags: - Specs operationId: getSpecDefinition responses: '200': $ref: '#/components/responses/getSpecDefinition' '400': $ref: '#/components/responses/apiSpec400Error' '401': $ref: '#/components/responses/apiSpec401Error' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/specId' /specs/{specId}/files: get: summary: Get a spec's files description: Gets all the files in an API specification. tags: - Specs - Spec Files operationId: getSpecFiles responses: '200': $ref: '#/components/responses/getSpecFiles' '401': $ref: '#/components/responses/apiSpec401Error' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '500': $ref: '#/components/responses/common500Error' post: summary: Create a spec file description: | Creates a file for an OpenAPI or a protobuf 2 or 3 specification. **Note:** - If the file path contains a `/` (forward slash) character, then a folder is created. For example, if the path is the `components/schemas.json` value, then a `components` folder is created with the `schemas.json` file inside. - Creating a spec file assigns it the `DEFAULT` file type. - Multi-file specifications can only have one root file. - Files cannot exceed a maximum of 10 MB in size. tags: - Specs - Spec Files operationId: createSpecFile requestBody: $ref: '#/components/requestBodies/createSpecFile' responses: '201': $ref: '#/components/responses/createUpdateSpecFileResponse' '400': $ref: '#/components/responses/apiSpecFiles400Error' '401': $ref: '#/components/responses/apiSpec401Error' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/specId' /specs/{specId}/files/{filePath}: get: summary: Get a spec file description: Gets the contents of an API specification's file. tags: - Specs - Spec Files operationId: getSpecFile responses: '200': $ref: '#/components/responses/getSpecFile' '400': $ref: '#/components/responses/apiSpecFiles400Error' '401': $ref: '#/components/responses/apiSpec401Error' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '500': $ref: '#/components/responses/common500Error' patch: summary: Update a spec file description: | Updates a file for an OpenAPI or protobuf 2 or 3 specification. **Note:** - This endpoint does not accept an empty request body. You must pass one of the accepted values. - This endpoint does not accept multiple request body properties in a single call. For example, you cannot pass both the `content` and `type` property at the same time. - Multi-file specifications can only have one root file. - When updating a file type to `ROOT`, the previous root file is updated to the `DEFAULT` file type. - Files cannot exceed a maximum of 10 MB in size. tags: - Specs - Spec Files operationId: updateSpecFile requestBody: $ref: '#/components/requestBodies/updateSpecFile' responses: '200': $ref: '#/components/responses/createUpdateSpecFileResponse' '400': $ref: '#/components/responses/apiSpecFiles400Error' '401': $ref: '#/components/responses/apiSpec401Error' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '500': $ref: '#/components/responses/common500Error' delete: summary: Delete a spec file description: Deletes a file in an API specification. On success, this returns an HTTP `204 No Content` response. tags: - Specs - Spec Files operationId: deleteSpecFile responses: '204': description: No Content '400': $ref: '#/components/responses/apiSpecFiles400Error' '401': $ref: '#/components/responses/apiSpec401Error' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/specId' - $ref: '#/components/parameters/filePath' /specs/{specId}/generations/{elementType}: get: summary: Get a spec's generated collections description: Gets all of an API specification's generated collections. tags: - Specs - Spec Collections operationId: getSpecCollections parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' responses: '200': $ref: '#/components/responses/getSpecCollections' '401': $ref: '#/components/responses/apiSpec401Error' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '500': $ref: '#/components/responses/common500Error' post: summary: Generate a collection from spec description: Creates a collection from the given OpenAPI 2.0, 3.0, or 3.1 specification or Smithy specification. The response contains a polling link to the task status. tags: - Specs - Spec Collections operationId: generateCollection requestBody: $ref: '#/components/requestBodies/generateCollection' responses: '202': $ref: '#/components/responses/generateTaskResponse' '401': $ref: '#/components/responses/apiSpec401Error' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '423': $ref: '#/components/responses/apiSpec423ErrorLocked' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/specId' - $ref: '#/components/parameters/elementTypeCollection' /specs/{specId}/synchronizations: put: summary: Sync spec with collection description: | Syncs an API specification linked to a collection. This is an asynchronous endpoint that returns an HTTP `202 Accepted` response. **Note:** - This endpoint only supports the OpenAPI 2.0, 3.0, and 3.1 specification types. - You can only sync collections generated from the given specification ID. tags: - Specs - Generated Specs operationId: syncSpecWithCollection parameters: - $ref: '#/components/parameters/collectionUniqueIdQuery' responses: '202': $ref: '#/components/responses/generateTaskResponse' '401': $ref: '#/components/responses/apiSpec401Error' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/specId' /specs/{specId}/version-tags/{tagId}/files: get: summary: Get a version tag description: Gets information about a specification's version tag. The response returns a snapshot of a specification at a point in time that lets you track changes to your specifications over time. operationId: getSpecVersionTag tags: - Specs - Version Tags responses: '200': $ref: '#/components/responses/getSpecVersionTag' '401': $ref: '#/components/responses/apiSpec401Error' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/specId' - $ref: '#/components/parameters/tagId' /specs/{specId}/version-tags: get: summary: Get a specification's version tags description: Gets a list of a specification's version tags. operationId: getSpecVersionTags tags: - Specs - Version Tags responses: '200': $ref: '#/components/responses/getSpecVersionTags' '401': $ref: '#/components/responses/apiSpec401Error' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/specId' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' post: summary: Create a version tag description: | Creates a version tag for a specification. Version tags are snapshots of a specification at a point in time that let you to track changes to your specifications over time. **Note:** Conflicts can occur if you try to create a version tag for a changelog group that already has a version tag. To resolve this, make new changes to the specification to create a new changelog group, then create a version tag on that new changelog group. operationId: createSpecVersionTag tags: - Specs - Version Tags requestBody: $ref: '#/components/requestBodies/createSpecVersionTag' responses: '201': $ref: '#/components/responses/createSpecVersionTagResponse' '400': $ref: '#/components/responses/apiSpec400Error' '401': $ref: '#/components/responses/apiSpec401Error' '403': $ref: '#/components/responses/apiSpec403Error' '404': $ref: '#/components/responses/apiSpec404Error' '409': $ref: '#/components/responses/apiSpec409Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/specId' /teams: post: summary: Create a team description: | [Creates](https://learning.postman.com/docs/administration/managing-your-team/create-teams/) a Postman team in your organization. operationId: createTeam tags: - Teams requestBody: $ref: '#/components/requestBodies/createTeam' responses: '200': $ref: '#/components/responses/createGetTeamResponse' '400': $ref: '#/components/responses/teams400Error' '401': $ref: '#/components/responses/teams401Error' '403': $ref: '#/components/responses/teams403Error' '500': $ref: '#/components/responses/teams500Error' get: summary: Get all teams description: Gets all Postman teams in your organization. operationId: getTeams tags: - Teams responses: '200': $ref: '#/components/responses/getTeams' '400': $ref: '#/components/responses/teams400Error' '401': $ref: '#/components/responses/teams401Error' '500': $ref: '#/components/responses/teams500Error' parameters: - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limitDefault50' - $ref: '#/components/parameters/teamSettingsQuery' - $ref: '#/components/parameters/userRolesQuery' parameters: - $ref: '#/components/parameters/identifierType' /teams/{teamId}: get: summary: Get a team description: Gets information about a Postman team. tags: - Teams operationId: getTeam parameters: - $ref: '#/components/parameters/teamsInclude' responses: '200': $ref: '#/components/responses/createGetTeamResponse' '400': $ref: '#/components/responses/teams400Error' '401': $ref: '#/components/responses/teams401Error' '500': $ref: '#/components/responses/teams500Error' parameters: - $ref: '#/components/parameters/teamId' - $ref: '#/components/parameters/identifierType' /teams/{teamId}/access-requests: get: summary: Get a team's access requests description: Gets a team's pending access requests. operationId: getTeamAccessRequests tags: - Teams - Access Requests parameters: - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limitDefault50' responses: '200': $ref: '#/components/responses/getTeamAccessRequests' '400': $ref: '#/components/responses/teams400Error' '401': $ref: '#/components/responses/teams401Error' '403': $ref: '#/components/responses/teams403Error' '500': $ref: '#/components/responses/teams500Error' post: summary: Create an access request description: | Creates an access request for a team. Access requests include actions such as request to join a team, upgrading a user's role, adding members, and requesting team role access to another team. **Note:** If a team discovery is enabled, the team's access request is automatically approved. operationId: createAccessRequest tags: - Teams - Access Requests requestBody: $ref: '#/components/requestBodies/createAccessRequest' responses: '200': $ref: '#/components/responses/createTeamAccessRequestResponse' '400': $ref: '#/components/responses/teams400Error' '401': $ref: '#/components/responses/teams401Error' '500': $ref: '#/components/responses/teams500Error' parameters: - $ref: '#/components/parameters/teamId' - $ref: '#/components/parameters/identifierType' /teams/{teamId}/access-requests/{requestId}: post: summary: Approve or deny an access request description: Approve or deny a team's access request. operationId: approveDenyAccessRequest tags: - Teams - Access Requests requestBody: $ref: '#/components/requestBodies/approveDenyAccessRequest' responses: '200': $ref: '#/components/responses/approveDenyAccessRequestResponse' '400': $ref: '#/components/responses/teams400Error' '401': $ref: '#/components/responses/teams401Error' '403': $ref: '#/components/responses/teams403Error' '404': $ref: '#/components/responses/teams404Error' '500': $ref: '#/components/responses/teams500Error' parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/teamId' - $ref: '#/components/parameters/accessRequestId' /teams/{teamId}/bulk-members: post: summary: Manage team member roles description: | Adds or removes member roles in groups, teams, organizations, as well as individual users' roles. **Note:** If you remove a role from a group or team, then all members lose the that role's permissions. operationId: manageTeamMemberRoles tags: - Teams requestBody: $ref: '#/components/requestBodies/manageTeamMemberRoles' responses: '200': $ref: '#/components/responses/manageTeamMemberRolesResponse' '400': $ref: '#/components/responses/teams400Error' '401': $ref: '#/components/responses/teams401Error' '500': $ref: '#/components/responses/teams500Error' delete: summary: Remove team members description: Removes entities, such as users or organizations, from your Postman team. On success, this returns an HTTP `204 No Content` response. operationId: removeTeamMembers tags: - Teams requestBody: $ref: '#/components/requestBodies/removeTeamMembers' responses: '204': description: Remove Team Member '400': $ref: '#/components/responses/teams400Error' '401': $ref: '#/components/responses/teams401Error' '403': $ref: '#/components/responses/teams403Error' '500': $ref: '#/components/responses/teams500Error' parameters: - $ref: '#/components/parameters/teamId' - $ref: '#/components/parameters/identifierType' /teams/{teamId}/settings: put: summary: Update team settings description: Updates a team's settings. operationId: updateTeamSettings tags: - Teams - Team Settings requestBody: $ref: '#/components/requestBodies/updateTeamSettings' responses: '200': $ref: '#/components/responses/createGetTeamSettingsResponse' '400': $ref: '#/components/responses/teams400Error' '401': $ref: '#/components/responses/teams401Error' '500': $ref: '#/components/responses/teams500Error' get: summary: Get a team's settings description: Gets a team's settings. operationId: getTeamSettings tags: - Teams - Team Settings responses: '200': $ref: '#/components/responses/createGetTeamSettingsResponse' '400': $ref: '#/components/responses/teams400Error' '401': $ref: '#/components/responses/teams401Error' '500': $ref: '#/components/responses/teams500Error' parameters: - $ref: '#/components/parameters/teamId' /users: get: summary: Get all team users description: Gets information about all users on the [Postman team](https://learning.postman.com/docs/collaborating-in-postman/working-with-your-team/collaboration-overview/). operationId: getTeamUsers tags: - Users responses: '200': $ref: '#/components/responses/getTeamUsers' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/groupId-2' /users/{userId}: get: summary: Get a team user description: Gets information about a user on the Postman team. operationId: getTeamUser tags: - Users responses: '200': $ref: '#/components/responses/getTeamUser' '400': $ref: '#/components/responses/common400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/userId' /webhooks: post: summary: Create a webhook description: | 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. **Note:** If you do not include the `workspace` query parameter, the system creates the webhook in the oldest personal Internal workspace you own. operationId: createWebhook tags: - Webhooks requestBody: $ref: '#/components/requestBodies/createWebhook' responses: '200': $ref: '#/components/responses/createWebhook' '400': $ref: '#/components/responses/createWebhookParamMissing400Error' '401': $ref: '#/components/responses/common401Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceQueryTrue' /workspaces: get: summary: Get all workspaces description: | Gets all [workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-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 ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)). - `public` — Everyone can access the workspace. - `partner` — Only invited team members and [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can access the workspace ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)). operationId: getWorkspaces tags: - Workspaces responses: '200': $ref: '#/components/responses/getWorkspaces' '400': $ref: '#/components/responses/workspaces400Error' '401': $ref: '#/components/responses/common401Error' '429': $ref: '#/components/responses/common429ErrorRateLimited' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceTypeQuery' - $ref: '#/components/parameters/workspaceCreatedBy' - $ref: '#/components/parameters/workspacesIncludeQuery' - $ref: '#/components/parameters/workspaceElementTypeQuery' - $ref: '#/components/parameters/workspaceElementIdQuery' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limitMax100' post: summary: Create a workspace description: | Creates a new [workspace](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/). **Note:** - This endpoint returns a 403 `Forbidden` response if the user does not have permission to create workspaces. [Admins and Super Admins](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) can configure workspace permissions to restrict users and/or user groups from creating workspaces or require approvals for the creation of team workspaces. - Private and [Partner Workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) are available on Postman [**Team** and **Enterprise** plans](https://www.postman.com/pricing). - There are rate limits when publishing public workspaces. - Public team workspace names must be unique. - The `teamId` property must be passed in the request body if [Postman Organizations](https://learning.postman.com/docs/administration/onboarding-checklist) is enabled. operationId: createWorkspace tags: - Workspaces requestBody: $ref: '#/components/requestBodies/createWorkspace' responses: '200': $ref: '#/components/responses/createWorkspace' '400': $ref: '#/components/responses/workspacePostPut400Errors' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/workspace403ErrorUnauthorized' '429': $ref: '#/components/responses/common429ErrorRateLimited' '500': $ref: '#/components/responses/common500Error' /workspaces-roles: get: summary: Get all roles description: Gets information about all roles in a workspace, based on the team's [plan](https://www.postman.com/pricing/). operationId: getAllWorkspaceRoles tags: - Workspaces - Roles responses: '200': $ref: '#/components/responses/getAllWorkspaceRoles' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '500': $ref: '#/components/responses/common500Error' /workspaces/{workspaceId}: get: summary: Get a workspace description: | Gets information about a workspace. **Note:** This endpoint's response contains the `visibility` field. [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-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 ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)). - `public` — Everyone can access the workspace. - `partner` — Only invited team members and [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can access the workspace ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)). operationId: getWorkspace tags: - Workspaces responses: '200': $ref: '#/components/responses/getWorkspace' '401': $ref: '#/components/responses/common401Error' '404': $ref: '#/components/responses/workspace404ErrorNotFound' '429': $ref: '#/components/responses/common429ErrorRateLimited' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceIncludeQuery' put: summary: Update a workspace description: | Updates a workspace's property, such as its name or visibility. **Note:** - This endpoint does not support the following visibility changes: - `private` to `public`, `public` to `private`, and `private` to `personal` for **Free** and **Solo** [plans](https://www.postman.com/pricing/). - `public` to `personal` for team users only. - There are rate limits when publishing public workspaces. - Public team workspace names must be unique. operationId: updateWorkspace tags: - Workspaces requestBody: $ref: '#/components/requestBodies/updateWorkspace' responses: '200': $ref: '#/components/responses/updateWorkspace' '400': $ref: '#/components/responses/workspacePostPut400Errors' '403': $ref: '#/components/responses/workspace403Error' '404': $ref: '#/components/responses/instanceNotFoundWorkspace' '429': $ref: '#/components/responses/common429ErrorRateLimited' '500': $ref: '#/components/responses/common500Error' delete: summary: Delete a workspace description: Deletes an existing workspace. operationId: deleteWorkspace tags: - Workspaces responses: '200': $ref: '#/components/responses/deleteWorkspace' '400': $ref: '#/components/responses/workspace400Error' '401': $ref: '#/components/responses/common401Error' '429': $ref: '#/components/responses/common429ErrorRateLimited' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceId' /workspaces/{workspaceId}/activities: get: summary: Get a workspace's activity feed description: Gets a workspace's [activity feed](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/changelog-and-restoring-collections/#view-workspace-activity). Activity feeds return information about who added or removed collections, environments, or elements from a workspace, and users that join or leave a workspace. operationId: getWorkspaceActivityFeed tags: - Workspaces - Activity Feed responses: '200': $ref: '#/components/responses/getWorkspaceActivityFeed' '400': $ref: '#/components/responses/workspaceFeed400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/workspaceCommon404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/userIdQuery' - $ref: '#/components/parameters/elementType-2' - $ref: '#/components/parameters/limitDefault15' - $ref: '#/components/parameters/cursor' /workspaces/{workspaceId}/element-transfers: post: summary: Transfer element to a workspace description: | Transfers a [Postman element](https://learning.postman.com/docs/getting-started/basics/postman-elements/) from one workspace to another workspace. Supported elements include collections, environments, mocks, monitors, and Flows modules and actions. When copying an element between workspaces, the [activity feed](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/workspace-activity/) for both workspaces update to reflect the change. **Note:** This endpoint does not support transferring elements from team workspaces to personal workspaces. operationId: transferWorkspaceElement tags: - Workspaces requestBody: $ref: '#/components/requestBodies/transferWorkspaceElement' responses: '200': $ref: '#/components/responses/transferWorkspaceElementResponse' '400': $ref: '#/components/responses/transferWorkspaceElement400Error' '403': $ref: '#/components/responses/transferWorkspaceElement403Error' '404': $ref: '#/components/responses/transferWorkspaceElement404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceId' /workspaces/{workspaceId}/global-variables: get: summary: Get global variables description: Gets a workspace's global [variables](https://learning.postman.com/docs/sending-requests/variables/#variable-scopes). Global variables enable you to access data between collections, requests, scripts, and environments and are available throughout a workspace. operationId: getWorkspaceGlobalVariables tags: - Workspaces - Global Variables responses: '200': $ref: '#/components/responses/getWorkspaceGlobalVariables' '500': $ref: '#/components/responses/globalVariables500Error' put: summary: Update global variables description: Updates and replaces a workspace's global [variables](https://learning.postman.com/docs/sending-requests/variables/#variable-scopes). This endpoint replaces all existing global variables with the variables you pass in the request body. operationId: updateWorkspaceGlobalVariables tags: - Workspaces - Global Variables requestBody: $ref: '#/components/requestBodies/updateWorkspaceGlobalVariables' responses: '200': $ref: '#/components/responses/updateWorkspaceGlobalVariables' '500': $ref: '#/components/responses/globalVariables500Error' parameters: - $ref: '#/components/parameters/workspaceId' /workspaces/{workspaceId}/roles: patch: summary: Update workspace roles description: | Updates the roles of users, [user groups](https://learning.postman.com/docs/collaborating-in-postman/user-groups/), or partners in a workspace. To get a list of roles, use the GET `/workspace-roles` endpoint. To get a group ID, use the GET `/groups` endpoint. **Note:** - User groups are available on Postman [**Enterprise** plans](https://www.postman.com/pricing). - To use SCIM IDs for users and user groups, include the `identifierType=scim` header when you call this endpoint. To get SCIM user IDs, include the `include=scim` query parameter when calling the GET `/workspaces/{workspaceId}` or GET `/workspaces` endpoints. - You can't set roles for users in personal workspaces. - This endpoint doesn't support the external [Guest role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles). - The partner **Editor** and **Editor and Partner Lead** roles aren't supported in multi-partner workspaces. - You can't update partner and user roles in the same operation. - This endpoint is restricted to 50 operations per call. - The request body must contain one unique action per user, user group, or partner. For example, you cannot add and remove multiple roles for a user in the same request body. operationId: updateWorkspaceRoles tags: - Workspaces - Roles requestBody: $ref: '#/components/requestBodies/updateWorkspaceRoles' responses: '200': $ref: '#/components/responses/updateWorkspaceRoles' '400': $ref: '#/components/responses/workspaceRoles400Error' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '422': $ref: '#/components/responses/workspaceRoles422Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/identifierType-2' get: summary: Get a workspace's roles description: | Gets the roles of users, user groups, and partners in a workspace. **Note:** Partner roles don't support SCIM IDs. operationId: getWorkspaceRoles tags: - Workspaces - Roles responses: '200': $ref: '#/components/responses/getWorkspaceRoles' '401': $ref: '#/components/responses/common401Error' '403': $ref: '#/components/responses/common403Error' '404': $ref: '#/components/responses/common404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceIncludeScimQuery' parameters: - $ref: '#/components/parameters/workspaceId' /workspaces/{workspaceId}/tags: get: summary: Get a workspace's tags description: Gets all the tags associated with a workspace. operationId: getWorkspaceTags tags: - Tags - Workspace Tags responses: '200': $ref: '#/components/responses/tagGetPut' '401': $ref: '#/components/responses/tag401Error' '403': $ref: '#/components/responses/tag403Error' '404': $ref: '#/components/responses/tag404Error' '500': $ref: '#/components/responses/tag500Error' put: summary: Update a workspace's tags description: Updates a workspace's associated tags. This endpoint replaces all existing tags with those you pass in the request body. operationId: updateWorkspaceTags tags: - Tags - Workspace Tags requestBody: $ref: '#/components/requestBodies/tagUpdateTags' responses: '200': $ref: '#/components/responses/tagGetPut' '400': $ref: '#/components/responses/tag400Error' '401': $ref: '#/components/responses/tag401Error' '403': $ref: '#/components/responses/tag403Error' '404': $ref: '#/components/responses/tag404Error' '500': $ref: '#/components/responses/tag500Error' parameters: - $ref: '#/components/parameters/workspaceId' /workspaces/{workspaceId}/transfers: patch: summary: Transfer workspace to a team description: | Transfers a workspace from one team (`source`) to another team (`destination`). **Note:** - These endpoints are only available with [Postman **Enterprise** plans](https://www.postman.com/pricing/) with [Postman Organizations](https://learning.postman.com/docs/administration/onboarding-checklist) enabled. - Team user roles are modified when workspaces are transferred. For example, if a user has the Admin role in the `source` team but not the `destination` team, then their role is removed from the workspace after it's transferred to the `destination` team. operationId: transferWorkspaceToTeam x-postman-plan: Enterprise tags: - Workspaces requestBody: $ref: '#/components/requestBodies/transferWorkspaceToTeam' responses: '200': $ref: '#/components/responses/transferWorkspaceToTeamResponse' '400': $ref: '#/components/responses/transferWorkspaceToTeam400Error' '401': $ref: '#/components/responses/transferWorkspaceToTeam401Error' '403': $ref: '#/components/responses/transferWorkspaceToTeam403Error' '404': $ref: '#/components/responses/transferWorkspaceToTeam404Error' '500': $ref: '#/components/responses/transferWorkspaceToTeam500Error' parameters: - $ref: '#/components/parameters/workspaceId' /workspaces/{workspaceId}/updates: get: summary: Get all workspace updates description: Gets a list of workspace updates for the given workspace. operationId: getWorkspaceUpdates tags: - Workspaces - Workspace Updates parameters: - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/workspaceUpdateCategory' responses: '200': $ref: '#/components/responses/getWorkspaceUpdates' '400': $ref: '#/components/responses/workspaceUpdates400Error' '401': $ref: '#/components/responses/workspaceUpdates401Error' '403': $ref: '#/components/responses/workspaceUpdates403Error' '404': $ref: '#/components/responses/workspaceUpdates404Error' '500': $ref: '#/components/responses/common500Error' post: summary: Create a workspace update description: Creates a [workspace update](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/internal-workspaces/workspace-updates) in the given workspace. Workspace updates keep workspace watchers informed about changes, such as new features, bug fixes, breaking changes, and announcements. operationId: createWorkspaceUpdate tags: - Workspaces - Workspace Updates requestBody: $ref: '#/components/requestBodies/createWorkspaceUpdate' responses: '200': $ref: '#/components/responses/createWorkspaceUpdateResponse' '400': $ref: '#/components/responses/workspaceUpdates400Error' '401': $ref: '#/components/responses/workspaceUpdates401Error' '403': $ref: '#/components/responses/workspaceUpdates403Error' '404': $ref: '#/components/responses/workspaceUpdates404Error' '422': $ref: '#/components/responses/workspaceUpdates422Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceId' /workspaces/{workspaceId}/updates/{updateId}: get: summary: Get a workspace update description: Gets information about a workspace update. operationId: getWorkspaceUpdate tags: - Workspaces - Workspace Updates responses: '200': $ref: '#/components/responses/getWorkspaceUpdate' '401': $ref: '#/components/responses/workspaceUpdates401Error' '403': $ref: '#/components/responses/workspaceUpdates403Error' '404': $ref: '#/components/responses/workspaceUpdates404Error' '500': $ref: '#/components/responses/common500Error' patch: summary: Update a workspace update description: | Updates a workspace update. **Note:** This endpoint requires the `application/merge-patch+json` Content-Type header. operationId: patchWorkspaceUpdate tags: - Workspaces - Workspace Updates requestBody: $ref: '#/components/requestBodies/updateWorkspaceUpdate' responses: '200': $ref: '#/components/responses/updateWorkspaceUpdateResponse' '400': $ref: '#/components/responses/workspaceUpdates400Error' '401': $ref: '#/components/responses/workspaceUpdates401Error' '403': $ref: '#/components/responses/workspaceUpdates403Error' '404': $ref: '#/components/responses/workspaceUpdates404Error' '415': $ref: '#/components/responses/workspaceUpdates415Error' '422': $ref: '#/components/responses/workspaceUpdates422Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/contentTypeMerge-PatchHeaderHeader' delete: summary: Delete a workspace update description: Deletes a workspace update. On success, this returns an HTTP `204 No Content` response. operationId: deleteWorkspaceUpdate tags: - Workspaces - Workspace Updates responses: '204': description: Workspace Update Deleted '401': $ref: '#/components/responses/workspaceUpdates401Error' '403': $ref: '#/components/responses/workspaceUpdates403Error' '404': $ref: '#/components/responses/workspaceUpdates404Error' '500': $ref: '#/components/responses/common500Error' parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/workspaceUpdateId' components: securitySchemes: basicAuth: type: http scheme: basic PostmanApiKey: type: apiKey in: header name: x-api-key scimApiKey: type: apiKey in: header name: Authorization description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints. schemas: invoicesSlots: type: object description: Information about the team's slots. properties: available: type: integer description: The number of the team's available slots. example: 8 consumed: type: integer description: The number of currently-billed team members. example: 2 total: type: integer description: The total number of slots available to the team. example: 10 unbilled: type: integer description: The number of unbilled slots if [auto-flex billing](https://learning.postman.com/auto-flex-policy/) is available. example: 0 invoicesAccountInfo: title: Account Information type: object description: Information about the account. properties: billingEmail: type: string format: email description: The email address to which invoices are sent. example: taylor.lee@example.com id: type: integer description: The account's ID. example: 12345678 state: type: string description: | The account's current state: - `FREE` - `PAID` - `EXPIRED_TRIAL` - `OVERDUE` - `SUSPENDED` - `BLOCKED` - `PAYMENT_DISPUTED` example: PAID teamId: type: integer description: The team's ID associated with the account. example: 1234 salesChannel: type: string description: | The sales channel from which the account was created: - `SELF_SERVE` — The user purchased the account plan. - `SALES_SERVE` — The account was purchased through the Postman sales team process. enum: - SELF_SERVE - SALES_SERVE example: SELF_SERVE slots: $ref: '#/components/schemas/invoicesSlots' commonErrorTypeTitleDetailStatus: title: Error (Type, Title, Detail, Status) type: object properties: type: description: The type of error. anyOf: - type: string title: URI Reference format: uri-reference description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem. example: https://api.postman.com/problems/bad-request - type: string title: Reference description: The type of error. title: type: string description: A short summary of the problem. example: Forbidden detail: type: string description: Information about the error. example: Forbidden status: type: integer format: http-status-code description: The error's HTTP status code. example: 403 commonErrorNameMessage: title: Error (Name, Message) type: object properties: error: type: object description: Information about the error. properties: name: type: string description: The error name. example: serverError message: type: string description: The error message. example: An error has occurred on the server. commonErrorTypeTitleDetail: title: Error (Type, Title, Detail) type: object properties: type: type: string description: The type of error. example: badRequest title: type: string description: A short summary of the problem. example: Invalid request detail: description: Information about the error. anyOf: - type: string title: string - type: object title: object example: Missing parameter, workspaceId billingAccountId: type: string example: '123456' billingAccountStatus: type: string enum: - PAID example: PAID invoicesTotal: type: object description: Information about the invoice's total billed amount. properties: value: type: integer description: The amount billed. example: 440 currency: type: string description: The currency of the billed amount. Currently only supports the `USD` value. example: USD invoicesLinks: type: object description: A [JSON API spec](https://jsonapi.org/format/#document-links) object containing hypermedia links. properties: web: type: object description: An object containing web-based account references. properties: href: type: string format: url description: A URL where you can download the invoice in PDF and view details. example: https://pay.postman.com/invoices/pay?invoice_public_id=inv_7UDSYBJPGQU93N7M invoiceData: title: Account Invoice type: object description: Information about the invoice. properties: id: type: string description: The invoice's ID. example: inv_7UDSYBJPGQU93N7M status: type: string description: The invoice's status. example: PAID issuedAt: type: string format: date description: The date on which the invoice was issued. example: '2023-10-12' totalAmount: $ref: '#/components/schemas/invoicesTotal' links: $ref: '#/components/schemas/invoicesLinks' getAccountInvoices: type: object required: - data properties: data: type: array description: A list of account invoices. items: $ref: '#/components/schemas/invoiceData' analyticsResource: type: string enum: - user - team - workspace - ai - api_development - api_testing - api_production - api_distribution - api_management example: workspace analyticsMetrics: type: string enum: - active_users - workspace_active_users - elements_in_workspace - active_workspaces - api_calls - active_collections - response_status - pending_invites - needs_attention - success_rate - user_requests - user_api_journey - workspace_distribution - internal_workspace_distribution - license_consumption - members - last_autoflex_cycle - partner_engagement_funnel - collection_error_aggregate - agent_mode_users - new_vs_returning_users - agent_mode_sessions - messages_sent - credit_usage - credit_usage_by_model - usage_leaderboard - peak_activity - activity_distribution - top_agent_models_by_usage - entity_activity - top_entities - runs - functional_test_runs - performance_test_runs - monitor_runs - flow_executions - pvt_network - partner - public - workspace_activity - members_overtime - member_invites - invites_sent - invites_accepted example: active_workspaces analyticsView: type: string enum: - detailed - summary - trend example: detailed analyticsWorkspaceType: type: string example: public analyticsUserId: type: string example: '12345678' analyticsDuration: type: string enum: - last_30_days - last_180_days - last_month - last_6_months - last_7_days - last_1_year example: last_30_days analyticsRequestId: type: string example: 12345678-c82dd02c-4870-4907-8fcb-593a876cf05b analyticsResponseStatus: type: string example: '404' analyticsAttentionType: type: string example: no_success_on_tried_request analyticsPeriod: type: string example: 2026-06 analyticsUserType: type: string enum: - new - returning example: returning analyticsEntityType: type: string enum: - collection - specification - mock - flow - sdk-collection - sdk-specification example: collection limitDefault100Max10000: type: integer default: 100 minimum: 1 maximum: 10000 example: 3 offsetMax10000: type: integer default: 0 minimum: 0 maximum: 10000 example: 5 getAnalyticsDataColumnsData: title: Analytics Columns Data type: array description: A list of column entries. items: type: object properties: name: type: string description: The name of the column. example: timestamp type: type: string description: The data type of the column. enum: - DATE - STRING - INTEGER - TIMESTAMP - BOOLEAN - NUMBER - FLOAT example: DATE format: type: string description: The data type's format. example: YYYY-MM-DD description: type: string description: A description of what the column represents. example: Reporting date for the aggregated metrics. getAnalyticsDataSchema: type: object description: The shape of the analytics data (column definitions). properties: columns: $ref: '#/components/schemas/getAnalyticsDataColumnsData' getAnalyticsDataRowsData: title: Analytics Rows Data type: array description: A list of data row entries. Each row is an array of values that correspond to the columns defined in the schema. items: type: array items: anyOf: - title: String type: string nullable: true - title: Integer type: integer - title: Number type: number - title: Boolean type: boolean example: '2025-03-01' getAnalyticsDataPaginationData: title: Pagination Data type: object description: Information about the response pagination. properties: total: type: integer description: The total number of records available. example: 42 limit: type: integer description: The maximum number of records returned in the response. example: 5 offset: type: integer description: The number of records skipped. example: 0 has_more: type: boolean description: Indicates whether more are records available. example: true getAnalyticsDataObject: title: Analytics Data Object type: object description: Data analytics information. properties: schema: $ref: '#/components/schemas/getAnalyticsDataSchema' rows: $ref: '#/components/schemas/getAnalyticsDataRowsData' pagination: $ref: '#/components/schemas/getAnalyticsDataPaginationData' getAnalyticsDataSummary: title: Analytics Data Summary type: object properties: summary: $ref: '#/components/schemas/getAnalyticsDataObject' required: - summary getAnalyticsDataAllPartners: title: Partners Engagement Partners Data type: object description: Information about partner users and their activity. properties: schema: $ref: '#/components/schemas/getAnalyticsDataSchema' rows: $ref: '#/components/schemas/getAnalyticsDataRowsData' pagination: $ref: '#/components/schemas/getAnalyticsDataPaginationData' getAnalyticsDataPartnerWorkspaceVisited: title: Partners Engagement Workspace Visits type: object description: Information about partner users' workspace visits. properties: schema: $ref: '#/components/schemas/getAnalyticsDataSchema' rows: $ref: '#/components/schemas/getAnalyticsDataRowsData' pagination: $ref: '#/components/schemas/getAnalyticsDataPaginationData' getAnalyticsDataPartnersViewedCollection: title: Partners Engagement Collection Views type: object description: Information about partner users' views of collections in a workspace. properties: schema: type: object description: The shape of the analytics data (column definitions). properties: columns: $ref: '#/components/schemas/getAnalyticsDataColumnsData' rows: $ref: '#/components/schemas/getAnalyticsDataRowsData' pagination: $ref: '#/components/schemas/getAnalyticsDataPaginationData' getAnalyticsDataPartnerRequestSent: title: Partners Engagement Requests Sent type: object description: Information about requests sent by partner users. properties: schema: type: object description: The shape of the analytics data (column definitions). properties: columns: $ref: '#/components/schemas/getAnalyticsDataColumnsData' rows: $ref: '#/components/schemas/getAnalyticsDataRowsData' pagination: $ref: '#/components/schemas/getAnalyticsDataPaginationData' getAnalyticsDataPartnerRequestSent200OK: title: Partners Engagement Successful Requests Sent type: object description: Information about partner users' successful request calls in a workspace. properties: schema: type: object description: The shape of the analytics data (column definitions). properties: columns: $ref: '#/components/schemas/getAnalyticsDataColumnsData' rows: $ref: '#/components/schemas/getAnalyticsDataRowsData' pagination: $ref: '#/components/schemas/getAnalyticsDataPaginationData' getAnalyticsDataPartnerEngagmentFunnel: title: Analytics Data Partner Engagement Funnel type: object properties: all_partners: $ref: '#/components/schemas/getAnalyticsDataAllPartners' workspace_visited: $ref: '#/components/schemas/getAnalyticsDataPartnerWorkspaceVisited' viewed_collection: $ref: '#/components/schemas/getAnalyticsDataPartnersViewedCollection' request_sent: $ref: '#/components/schemas/getAnalyticsDataPartnerRequestSent' successful_requests_200OK: $ref: '#/components/schemas/getAnalyticsDataPartnerRequestSent200OK' getAnalyticsData: type: object properties: data: description: The analytics data returned for the requested metric. anyOf: - $ref: '#/components/schemas/getAnalyticsDataSummary' - $ref: '#/components/schemas/getAnalyticsDataPartnerEngagmentFunnel' required: - data commonErrorTypeTitleDetailStatusInstance: title: Error (Type, Title, Detail, Status, Instance) type: object properties: type: type: string format: uri-reference description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem. example: https://api.postman.com/problems/length-required title: type: string description: A short summary of the problem. example: Length Required detail: type: string description: An explanation about the problem. example: A valid Content-Length header is required status: type: integer format: http-status-code description: The HTTP status code generated by the origin server. example: 411 instance: type: string description: The URI reference that identifies the specific occurrence of the problem. example: / analyticsMetadataInclude: type: string example: parameters,response analyticsMetadataResources: type: string example: user,workspace,team getAnalyticsMetadataResourceMetricsData: title: Analytics Metadata Metrics Data type: object description: Information about the resource's metric. properties: metric: type: string description: The metric's name. example: active_users description: type: string description: A description of the metric. example: Tracks user activity across workspaces over time. Provides detailed insights into individual user engagement including API request counts, system action counts, primary tasks, and last activity timestamps. Useful for understanding team productivity, identifying power users, and monitoring adoption trends. getAnalyticsMetadataResourceData: title: Analytics Metadata Resource Data type: object description: Information about the resource. properties: resource: type: string description: The name of the resource. example: user description: type: string description: A description of the resource. example: Metrics and insights related to individual user activities and engagement within Postman workspaces. metrics: type: array description: A list of the resource's accepted metrics values. items: $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsData' getAnalyticsMetadataResourceMetricsDataDetailedParametersView: type: object description: Information about the `view` parameter. properties: type: type: string description: The parameter's type. example: ENUM isRequired: type: boolean description: If true, the parameter is required. example: false allowed_values: type: array description: A list of the parameter's accepted values. items: type: string example: detailed description: type: string description: The parameter's description. example: Determines whether the metric returns detailed or summarized data. getAnalyticsMetadataResourceMetricsDataDetailedParametersFiltersData: type: object description: Information about the filter. properties: type: type: string description: The parameter's type. example: ENUM isRequired: type: boolean description: If true, the parameter is required. example: true allowed_values: type: array description: A list of the parameter's accepted values. items: type: string example: internal getAnalyticsMetadataResourceMetricsDataDetailedParametersFilters: description: The filters supported for the metric. anyOf: - type: array title: Array items: type: string - type: object title: Object description: Information about the filter parameters. properties: workspace_type: $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedParametersFiltersData' duration: $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedParametersFiltersData' getAnalticsMetadataPaginationData: type: object description: Information about the metric's pagination parameters. properties: supported: type: boolean description: If true, pagination is supported for this metric. example: true allowed_values: type: array description: A list of the supported pagination parameters. items: type: string example: limit getAnalyticsMetadataResourceMetricsDataDetailedParameters: type: object description: Information about the metric's parameters. properties: view: $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedParametersView' filters: $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedParametersFilters' pagination: $ref: '#/components/schemas/getAnalticsMetadataPaginationData' getAnalyticsMetadataResourceMetricsDataDetailedData: type: object description: Information about the metric's `detailed` parameter. properties: schema: type: object description: The response schema for the `detailed` view. properties: columns: $ref: '#/components/schemas/getAnalyticsDataColumnsData' getAnalyticsMetadataResourceMetricsDataSummaryData: type: object description: Information about the metric's `summary` parameter. properties: schema: type: object description: The response schema for the `summary` view. properties: columns: $ref: '#/components/schemas/getAnalyticsDataColumnsData' getAnalyticsMetadataResourceMetricsDataDetailedResponse: type: object description: Information about the metric's `response` parameters. properties: detailed: $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedData' summary: $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsDataSummaryData' getAnalyticsMetadataResourceMetricsDataDetailed: type: object description: Information about the resource's metric. properties: metric: type: string description: The metric's name. example: active_users description: type: string description: A description of the metric. example: Users who created, edited or sent requests within Postman workspaces type: type: string description: The metric's data type. example: string isRequired: type: boolean description: If true, the metric is required. example: true parameters: $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedParameters' response: $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedResponse' getAnalyticsMetadataParametersResponseData: title: Analytics Metadata with Parameters and Response Data type: object description: Detailed information about the resource including its metrics, parameters, and response schema. properties: resource: type: string description: The name of the resource. example: user description: type: string description: A description of the resource. example: Users who created, edited or sent requests within Postman workspaces type: type: string description: The metric's data type. example: string isRequired: type: boolean description: If true, the metric is required. example: true metrics: type: array description: A list of the resource's detailed accepted metrics values. items: $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailed' getAnalyticsMetadata: type: object properties: data: type: object description: The Analytics API's metadata information. properties: description: type: string description: A description of the endpoint. example: Metadata catalog for Analytics APIs that provide insights on API usage, success, and workspace/team trends in Postman. resources: type: array description: A list of accepted resource values. items: anyOf: - $ref: '#/components/schemas/getAnalyticsMetadataResourceData' - $ref: '#/components/schemas/getAnalyticsMetadataParametersResponseData' discoveryServicesSource: type: string enum: - api_gateway_app - insights_project - infra_watcher - public_api example: insights_project discoveryServicesStatus: type: string example: discovered discoveryServicesSearch: type: string example: Order limitDefault20: type: integer default: 20 minimum: 1 maximum: 100 example: 3 cursor: type: string example: RnJpIEZlYiAyNCAyMDIzIDEzOjI0OjA5IEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk= getApiCatalogDiscoveryMetaData: type: object description: The response's meta information for paginated results. properties: total: type: integer description: The number of records found. example: 5 nextCursor: type: string nullable: true description: The pagination cursor that points to the next record in the results set. example: eyJpZCI6N30= apiCatalogDiscoveryServicesTagsData: type: array maxItems: 50 description: A list of tags associated with the service. items: type: string example: auth getApiCatalogServiceData: type: object description: Information about the discovered service. properties: id: type: string description: The service's ID. example: 0eac9b7d-0603-4f16-8a4a-76c78df8fe26 name: type: string description: The service's name. example: Supply - stage (1.0.1) version: type: string nullable: true description: The service's version. example: 1.0.1 sourceEnvironment: type: string nullable: true description: The source environment in which the service was discovered. example: stage systemEnvironmentId: type: string nullable: true description: The mapped system environment's ID. Returns a null value if the environment is not mapped. example: null status: type: string description: The service's current status. example: discovered endpointsCount: type: integer description: The total number of endpoints associated with the service. example: 6 discoverySource: type: string description: The source through which the service was discovered. example: api_gateway_app tags: $ref: '#/components/schemas/apiCatalogDiscoveryServicesTagsData' discoveredAt: type: string format: date-time description: The date and time at which the service was first discovered. example: '2026-02-12T04:01:26.000Z' getApiCatalogDiscoveryServices: type: object properties: meta: $ref: '#/components/schemas/getApiCatalogDiscoveryMetaData' data: type: array description: A list of discovered services. items: $ref: '#/components/schemas/getApiCatalogServiceData' apiCatalogErrorPathMessage: type: object description: Information about the error. properties: path: type: string description: The path in which the error occurred. example: systemEnvironmentId message: type: string description: The error message. example: Must be a valid UUID apiCatalogError: title: Error (Type, Status, Title, Detail, Errors) type: object properties: type: type: string format: uri description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem. example: https://api.postman.com/problems/bad-request status: type: integer description: The HTTP status code generated by the origin server. example: 400 title: type: string description: A short summary of the problem. example: Bad Request detail: type: string description: An explanation about the problem. example: 'status values must be one of: discovered, archived, integrated' errors: type: array description: A list of errors. items: $ref: '#/components/schemas/apiCatalogErrorPathMessage' postApiCatalogDiscoveryServicesApiDefinitionData: type: object description: The API definition (specification) for the service. If you pass this with the `endpoints` array, this object is given preference and `endpoints` is ignored. properties: content: type: string description: A Base64-encoded JSON API definition. Cannot exceed 2 MB after decoding. example: eyJvcGVuYXBpIjoiMy4wLjAiLCJpbmZvIjp7InRpdGxlIjoiQ29uZmlnIiwidmVyc2lvbiI6IjEuMC4wIn0sInBhdGhzIjp7Ii9jb25maWciOnsiZ2V0Ijp7InN1bW1hcnkiOiJHZXQgY29uZmlnIn19LCIvY29uZmlnL3trZXl9Ijp7InB1dCI6eyJzdW1tYXJ5IjoiVXBkYXRlIGNvbmZpZyJ9fX19= apiCatalogDiscoveryServiceEndpointsData: type: object description: Information about a service's endpoint. properties: method: type: string description: The endpoint's HTTP method. example: GET path: type: string description: The endpoint's URL path. example: /api/recipes description: type: string nullable: true description: The endpoint's description. example: null host: type: string description: The endpoint's host. example: '' postApiCatalogDiscoveryServicesProviderMetadataData: type: object description: Additional metadata from the discovery source provider. properties: commitSha: type: string description: A commit hash ID. example: a1b2c3d4e5f6 branch: type: string description: The source provider's branch name. example: main gitRepoUrl: type: string description: The source provider's Git repo URL. example: https://github.com/acme/user-service deployedAt: type: string format: date-time description: The date and time at which the service was deployed. example: '2026-02-10T12:00:00Z' postApiCatalogDiscoveryServiceData: type: object required: - name description: Information about the discovered service. properties: name: type: string description: The service's name. example: user-service version: type: string description: The service's version. example: 3.0.0 providerServiceId: type: string description: The ID of the service in the source registry. If you do not pass this property, the system uses the `{name}:{version}` value. example: usr-svc-custom-id-001 description: type: string description: The service's description. example: Handles user registration, authentication, and profile management sourceEnvironment: type: string description: The service's source environment. example: production apiDefinition: $ref: '#/components/schemas/postApiCatalogDiscoveryServicesApiDefinitionData' endpoints: type: array maxItems: 100 description: A list of the service's endpoints. If you pass this with the `apiDefinition` array, this array is ignored. items: $ref: '#/components/schemas/apiCatalogDiscoveryServiceEndpointsData' tags: $ref: '#/components/schemas/apiCatalogDiscoveryServicesTagsData' providerMetadata: $ref: '#/components/schemas/postApiCatalogDiscoveryServicesProviderMetadataData' postApiCatalogDiscoveryServices: type: object required: - discoveredServices properties: discoveredServices: type: array minimum: 1 maximum: 20 description: A list of discovered services to add to the API Catalog. items: $ref: '#/components/schemas/postApiCatalogDiscoveryServiceData' postApiCatalogDiscoveryServicesServiceData: type: object description: Information about a discovered service. properties: id: type: string description: The service's ID. example: 9feb4e3c-0cd8-44db-b137-7bf09aee73cd organizationId: type: integer description: The ID of the organization that the service belongs to. example: 123 name: type: string description: The servie's name. example: user-service description: type: string nullable: true description: The service's description. example: Handles user registration, authentication, and profile management. version: type: string nullable: true description: The service's version. example: 3.0.0 sourceEnvironment: type: string nullable: true description: The source environment in which the service was discovered. example: production systemEnvironmentId: type: string nullable: true description: The mapped system environment's ID. Returns a null value if the environment is not mapped. example: null tags: $ref: '#/components/schemas/apiCatalogDiscoveryServicesTagsData' status: type: string description: The service's current status. example: discovered endpointsCount: type: integer description: The total number of endpoints associated with the service. example: 5 providerServiceId: type: string description: The ID of the service in the source registry. example: usr-svc-custom-id-001 discoveredAt: type: string format: date-time description: The date and time at which the service was first discovered. example: '2026-02-12T04:01:26.000Z' discoveredBy: type: integer description: The user ID of the user who discovered or ingested the service. example: 12345678 lastSyncedAt: type: string format: date-time description: The date and time of the most recent service sync. example: '2026-02-12T04:01:26.000Z' postApiCatalogDiscoveryServicesResponseMetaData: type: object description: The operation's metadata summary. properties: total: type: integer description: The total number of services processed. example: 1 created: type: integer description: The number of new services created. example: 1 updated: type: integer description: The number of existing services updated. example: 0 postApiCatalogDiscoveryServicesResponse: type: object properties: data: type: array description: A list of discovered services. items: $ref: '#/components/schemas/postApiCatalogDiscoveryServicesServiceData' meta: $ref: '#/components/schemas/postApiCatalogDiscoveryServicesResponseMetaData' serviceId: type: string example: c6ec74e7-14f8-498c-9470-7a654173bed6 apiCatalogDiscoveryServicesProviderMetadata: type: object description: Additional metadata from the discovery source provider. properties: title: type: string description: The provider's service display title. example: Jelly Bean Wiki (IBM - 10) - sandbox (1.0.0) environmentId: type: string description: The provider's environment ID. example: 048840c0-1be8-4d9f-a8a6-7429ca50f5ca,989213fc-b1a3-42cb-b0d6-b7843ee5d47d environmentVersion: type: string description: The provider's environment version. example: 2.0.0 openApiSpecCanBeDownloaded: type: boolean description: If true, the provider has enabled downloading of the OpenAPI specification. example: true getApiCatalogDiscoveryServiceApiDefinitionData: type: object description: The API definition associated with the service. properties: format: type: string description: The definition's format. example: openapi_3 formatVersion: type: string description: The API definition format's version. example: 3.0.1 contentHash: type: string description: A SHA-256 hash of the API definition content for change detection. example: 8839a589ba50f454a03f58ec761ad26e2d267a8f26bd63cf6298d4643b23ed7e content: type: string description: A Base64-encoded API definition. example: eyJvcGVuYXBpIjoiMy4wLjAiLCJpbmZvIjp7InRpdGxlIjoiQ29uZmlnIiwidmVyc2lvbiI6IjEuMC4wIn0sInBhdGhzIjp7Ii9jb25maWciOnsiZ2V0Ijp7InN1bW1hcnkiOiJHZXQgY29uZmlnIn19LCIvY29uZmlnL3trZXl9Ijp7InB1dCI6eyJzdW1tYXJ5IjoiVXBkYXRlIGNvbmZpZyJ9fX19= getApiCatalogDiscoveryService: type: object description: Information about the discovered service. properties: id: type: string description: The service's ID. example: c6ec74e7-14f8-498c-9470-7a654173bed6 organizationId: type: integer description: The ID of the organization that the service belongs to. example: 123 discoverySource: type: string description: The source through which the service was discovered. example: api_gateway_app name: type: string description: The servie's name. example: Jelly Bean Wiki (IBM - 10) - sandbox (1.0.0) description: type: string nullable: true description: The service's description. example: null version: type: string description: The service's version. example: 1.0.0 sourceEnvironment: type: string nullable: true description: The source environment in which the service was discovered. example: null systemEnvironmentId: type: string nullable: true description: The mapped system environment's ID. Returns a null value if the environment is not mapped. example: null tags: $ref: '#/components/schemas/apiCatalogDiscoveryServicesTagsData' status: type: string description: The service's current status. example: discovered providerServiceId: type: string description: The ID of the service in the source registry. example: 048840c0-1be8-4d9f-a8a6-7429ca50f5ca,989213fc-b1a3-42cb-b0d6-b7843ee5d47d,40d57331-ad73-47a3-87f0-032af447df8e providerMetadata: $ref: '#/components/schemas/apiCatalogDiscoveryServicesProviderMetadata' apiDefinition: $ref: '#/components/schemas/getApiCatalogDiscoveryServiceApiDefinitionData' endpoints: type: array description: A list of the service's endpoints. items: $ref: '#/components/schemas/apiCatalogDiscoveryServiceEndpointsData' endpointsCount: type: integer description: The total number of endpoints associated with the service. example: 3 discoveredAt: type: string format: date-time description: The date and time at which the service was first discovered. example: '2026-02-12T02:04:58.000Z' discoveredBy: type: integer description: The user ID of the user who discovered or ingested the service. example: 12345678 lastSyncedAt: type: string format: date-time description: The date and time of the most recent service sync. example: '2026-02-12T02:04:58.000Z' managedWorkspaceId: type: string nullable: true description: The ID of the Postman workspace that the service has been integrated into. Returns a null value if the service is not integrated. example: null integratedAt: type: string format: date-time nullable: true description: The date and time at which the service was linked to a Postman workspace. Returns a null value if the service is not integrated. example: null systemEnvironmentId: type: string example: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 apiCatalogServiceNameFilter: type: string maxLength: 255 example: acs apiCatalogServiceTagsFilter: type: string pattern: ^[^,]+(,[^,]+)*$ example: acs apiCatalogServiceGovernanceGroupIdFilter: type: string example: 4937d932-b1f4-44cd-a929-4a860707766e apiCatalogServiceMetadataNextCursorData: type: string nullable: true description: The pagination cursor that points to the next record in the results set. example: NzI0MTIzOTgsYWktc2VydmljZQ== apiCatalogServiceMetadataLimitData: type: integer description: The maximum number of records in the paginated response. example: 2 apiCatalogServiceMetadataFiltersData: type: object description: The filters applied to the request. example: {} apiCatalogServiceMetadataTimeRangeData: type: object description: The time window for the returned data. required: - start - end - label properties: start: type: string format: date-time description: The start of the time window. example: '2026-04-14T12:36:15.339Z' end: type: string format: date-time description: The end of the time window. example: '2026-04-21T12:36:15.339Z' label: type: string description: The time range's label. enum: - last_7_days example: last_7_days apiCatalogServiceServiceData: type: object description: Information about the service. required: - id - name - status - lastActivityAt - traffic - compliance - createdAt - gitRepo - owner - tags - governanceGroup properties: id: type: string description: The service's ID. example: a5450abd-ec89-443c-a17a-68132e738714 name: type: string description: The service's name. example: api-control-service status: type: string description: The overall health status, derived from compliance signals. enum: - healthy - warning - critical - inactive example: critical lastActivityAt: type: string nullable: true format: date-time description: The date and time of the last observed activity. If there's no activity in the time window, this returns a null value. example: '2026-04-21T12:36:00Z' traffic: type: object nullable: true description: Information about traffic and performance within the time window. If there's no traffic data, this returns a null value. required: - p95LatencyMs - errorRatePct properties: p95LatencyMs: type: number nullable: true description: The 95th-percentile response latency, in milliseconds. example: 251.8122497558594 errorRatePct: type: number nullable: true description: The percentage of requests that resulted in errors. example: 0.78 compliance: type: object description: Information about compliance and governance. required: - monitorRun - cliRun - specLint properties: monitorRun: type: object required: - status description: The scheduled monitor run summary. properties: status: type: string nullable: true description: Whether the monitor's latest runs passed or failed. If no runs exist, this returns a null value. enum: - passed - failed example: failed cliRun: type: object required: - status description: Information about the CI/CD pipeline. properties: status: type: string nullable: true description: Whether the pipelines' latest runs passed or failed. If no runs exist, this returns a null value. enum: - passed - failed example: failed specLint: type: object required: - status description: Information about the API specification lint. properties: status: type: string nullable: true description: Whether the specifications' latest lints passed or failed. If no lints exist, this returns a null value. enum: - passed - failed example: passed createdAt: type: string nullable: true format: date-time description: The date and time at which the workspace was created. example: '2025-12-04T15:13:31.000Z' gitRepo: type: string nullable: true format: uri description: The URL of the linked Git repository. If the workspace isn't connected to a repository, this returns a null value. example: https://github.com/acs-team/api-control-service owner: type: object nullable: true description: The service's owner. If no owner is assigned, this returns a null value. required: - type - id - name - profilePicUrl - publicHandle properties: type: type: string description: The type of owner. enum: - user - group example: user id: type: string description: The owner's ID. example: '12345678' name: type: string nullable: true description: The owner's display name. example: Taylor Lee profilePicUrl: type: string nullable: true format: uri description: The URL of the owner's profile picture. example: https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9 publicHandle: type: string nullable: true format: uri description: The URL of the owner's public profile. example: https://www.acs-beta.example.com/orbital-module-specialist-12345678 tags: type: array description: A list of the workspace's tags. items: type: string example: develop governanceGroup: type: object nullable: true description: The governance group that the workspace belongs to. If no governance group is assigned, this returns a null value. required: - id - name properties: id: type: string description: The governance group's ID. example: 4937d932-b1f4-44cd-a929-4a860707766e name: type: string description: The governance group's name. example: ACS getApiCatalogServices: type: object properties: meta: type: object description: The response's meta information for paginated results. required: - nextCursor - limit - filters - timeRange properties: nextCursor: $ref: '#/components/schemas/apiCatalogServiceMetadataNextCursorData' limit: $ref: '#/components/schemas/apiCatalogServiceMetadataLimitData' filters: $ref: '#/components/schemas/apiCatalogServiceMetadataFiltersData' timeRange: $ref: '#/components/schemas/apiCatalogServiceMetadataTimeRangeData' data: type: array description: A list of list of services. items: $ref: '#/components/schemas/apiCatalogServiceServiceData' getApiCatalogServiceTrafficData: type: object nullable: true description: Information about traffic and performance within the time window. If there's no traffic data, this returns a null value. properties: p95LatencyMs: type: number description: The 95th-percentile response latency, in milliseconds. example: 251.8122497558594 errorRatePct: type: number description: The percentage of requests that resulted in errors. example: 0.78 totalRequests: type: integer description: The total number of requests. example: 10999 totalRequestsDeltaPct: type: number nullable: true description: The percentage change in total requests compared to the preceding seven day window. example: 398.82 totalErrors: type: integer description: The total number of error responses. example: 86 totalEndpoints: type: integer description: The total number of distinct endpoints. example: 10 p95LatencyMsDeltaPct: type: number nullable: true description: The percentage change in p95 latency compared to the preceding seven day window. example: 0.47 errorRatePctDeltaPct: type: number nullable: true description: The percentage change in error rate compared to the preceding seven day window. example: 188.89 getApiCatalogServiceComplianceData: type: object description: Information about compliance and governance. required: - monitorRun - cliRun - specLint - collectionRuns properties: monitorRun: type: object description: The scheduled monitor run summary. required: - status - totalMonitors - activeMonitors - passingMonitors - failingMonitors - lastRunAt properties: status: type: string nullable: true description: Whether the monitor's latest runs passed or failed. If no runs exist, this returns a null value. enum: - passed - failed example: failed totalMonitors: type: integer description: The total number of monitors in the workspace. This value is the same as the as `entityCounts.monitors` value. example: 3 activeMonitors: type: integer description: The number of distinct monitors with at least one run in the time window. example: 3 passingMonitors: type: integer description: The number of distinct monitors whose latest run passed within the time window. example: 1 failingMonitors: type: integer description: The number of distinct monitors whose latest run failed within the time window. example: 2 lastRunAt: type: string nullable: true format: date-time description: The date and time of the most recent run across all monitors. If no runs exist, this returns a null value. example: '2026-04-21T13:09:24.847Z' cliRun: type: object description: Information about the CI/CD pipeline. required: - status - activePipelines - passingPipelines - failingPipelines - lastRunAt properties: status: type: string nullable: true description: Whether the pipelines' latest runs passed or failed. If no runs exist, this returns a null value. enum: - passed - failed example: failed activePipelines: type: integer description: The number of distinct pipelines with at least one run within the time window. example: 5 passingPipelines: type: integer description: The number of distinct pipelines whose latest run passed within the time window. example: 3 failingPipelines: type: integer description: The number of distinct pipelines whose latest run failed within the time window. example: 2 lastRunAt: type: string nullable: true format: date-time description: The date and time of the most recent run across all pipelines. If no runs exist, this returns a null value. example: '2026-04-19T12:08:43.112Z' specLint: type: object description: Information about the API specification lint. required: - status - totalSpecs - activeSpecs - passingSpecs - failingSpecs - lastRunAt properties: status: type: string nullable: true description: Whether the specifications' latest lints passed or failed. If no lints exist, this returns a null value. enum: - passed - failed example: passed totalSpecs: type: integer description: The total number of API specifications in the workspace. This value is the same as the as `entityCounts.specifications` value. example: 2 activeSpecs: type: integer description: The number of distinct specifications with at least one lint within the time window. example: 1 passingSpecs: type: integer description: The number of distinct specifications whose latest lint passed within the time window. example: 1 failingSpecs: type: integer description: The number of distinct specifications whose latest lint failed within the time window. example: 0 lastRunAt: type: string nullable: true format: date-time description: The date and time of the most recent lint run across all specifications. If no lint exist, this returns a null value. example: '2026-04-19T12:08:43.110Z' collectionRuns: type: object description: Information about collection runs, including monitor runs, CI pipeline runs, and manual runs. required: - totalRuns - passedRuns - failedRuns - passRate - totalCollections - activeCollections - totalAssertions - failedAssertions properties: totalRuns: type: integer description: The total number of collection runs. example: 3159 passedRuns: type: integer description: The number of collection runs that passed. example: 462 failedRuns: type: integer description: The number of collection runs that failed. example: 2697 passRate: type: number nullable: true description: The percentage of collection runs that passed. If no runs exist, this returns a null value. example: 14.62 totalCollections: type: integer description: The total number of collections in the workspace. This value is the same as the as `entityCounts.collections` value. example: 2 activeCollections: type: integer description: The number of distinct collections with at least one run within the time window. example: 2 totalAssertions: type: integer description: The total number of assertions evaluated. example: 161456 failedAssertions: type: integer description: The number of assertions that failed. example: 69355 getApiCatalogServiceEntityCountData: type: object description: Information about the workspace's entities. required: - collections - specifications - monitors - mocks - flows - environments properties: collections: type: integer description: The total number of collections. example: 2 specifications: type: integer description: The total number of API specifications. example: 2 monitors: type: integer description: The total number of monitors. example: 3 mocks: type: integer description: The total number of mock servers. example: 0 flows: type: integer description: The total number of Postman Flows. example: 0 environments: type: integer description: The total number of environments. example: 2 getApiCatalogServiceOwnerData: type: object nullable: true description: The service's owner. If no owner is assigned, this returns a null value. required: - type - id - name - profilePicUrl - publicHandle properties: type: type: string description: The type of owner. enum: - user - group example: user id: type: string description: The owner's ID. example: '12345678' name: type: string nullable: true description: The owner's display name. example: Taylor Lee profilePicUrl: type: string nullable: true format: uri description: The URL of the owner's profile picture. example: https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9 publicHandle: type: string nullable: true format: uri description: The URL of the owner's public profile. example: https://www.acs-beta.example.com/orbital-module-specialist-12345678 getApiCatalogService: type: object required: - meta - data properties: meta: type: object required: - timeRange description: The response's meta information for paginated results. properties: filters: $ref: '#/components/schemas/apiCatalogServiceMetadataFiltersData' timeRange: $ref: '#/components/schemas/apiCatalogServiceMetadataTimeRangeData' data: type: object description: Information about the service. required: - id - name - status - lastActivityAt - traffic - compliance - entityCounts - createdAt - gitRepo - owner - tags - governanceGroup - dependencies properties: id: type: string description: The service's ID. example: a5450abd-ec89-443c-a17a-68132e738714 name: type: string description: The service's name. example: api-control-service status: type: string description: The overall health status, derived from compliance signals. enum: - healthy - warning - critical - inactive example: critical lastActivityAt: type: string nullable: true format: date-time description: The date and time of the last observed activity. If there's no activity in the time window, this returns a null value. example: '2026-04-21T13:09:33Z' traffic: $ref: '#/components/schemas/getApiCatalogServiceTrafficData' compliance: $ref: '#/components/schemas/getApiCatalogServiceComplianceData' entityCounts: $ref: '#/components/schemas/getApiCatalogServiceEntityCountData' createdAt: type: string nullable: true format: date-time description: The date and time at which the workspace was created. example: '2025-12-04T15:13:31.000Z' gitRepo: type: string nullable: true format: uri description: The URL of the linked Git repository. If the workspace isn't connected to a repository, this returns a null value. example: https://github.com/acs-team/api-control-service owner: $ref: '#/components/schemas/getApiCatalogServiceOwnerData' tags: type: array description: A list of the workspace's tags. items: type: string example: acs governanceGroup: type: object nullable: true description: The governance group that the workspace belongs to. If no governance group is assigned, this returns a null value. required: - id - name properties: id: type: string description: The governance group's ID. example: 4937d932-b1f4-44cd-a929-4a860707766e name: type: string description: The governance group's name. example: ACS dependencies: type: array description: A list of inbound and outbound service dependencies from the service graph. items: type: object required: - id - name - direction properties: id: type: string description: The dependent service's ID. example: svc_3l2QDWTQQ161UYpSwGK34U name: type: string description: The dependent service's name. example: external direction: type: string description: Whether traffic flows into (inbound) or out of (outbound) the service. enum: - inbound - outbound example: inbound apiCatalogServiceHttpMethodFilter: type: string pattern: ^(GET|POST|PUT|PATCH|DELETE|HEAD|OPTIONS|TRACE)(,(GET|POST|PUT|PATCH|DELETE|HEAD|OPTIONS|TRACE))*$ example: GET,POST apiCatalogServiceHostsFilter: type: string pattern: ^[^,]+(,[^,]+)*$ example: acs-test-new.example.com apiCatalogServiceResponseCodeFilter: type: string pattern: ^\\d{3}(,\\d{3})*$ example: 200,400 apiCatalogServiceSearchFilter: type: string maxLength: 500 example: object-group apiCatalogServiceSortEndpointsFilter: type: string pattern: ^(count|endpoint|p95LatencyMs|errorRate):(asc|desc)$ example: errorRate:desc getApiCatalogServiceEndpoints: type: object required: - meta - data properties: meta: type: object description: The response's meta information for paginated results. required: - nextCursor - limit - filters - timeRange - totalEndpoints - totalRequests properties: nextCursor: $ref: '#/components/schemas/apiCatalogServiceMetadataNextCursorData' limit: $ref: '#/components/schemas/apiCatalogServiceMetadataLimitData' filters: $ref: '#/components/schemas/apiCatalogServiceMetadataFiltersData' timeRange: $ref: '#/components/schemas/apiCatalogServiceMetadataTimeRangeData' totalEndpoints: type: integer description: The total number of endpoints that match the given filters. example: 11 totalRequests: type: integer description: The total number of requests that match the given filters. example: 16022 data: type: array description: A list of observed API endpoints with traffic and performance metrics. items: type: object required: - method - path - host - requestCount - performance - errors properties: method: type: string description: The endpoint's HTTP method. enum: - GET - POST - PUT - PATCH - DELETE - HEAD - OPTIONS - TRACE example: DELETE path: type: string description: The endpoint's URL path template. example: /api/groups/delete host: type: string description: The hostname the endpoint was observed on. example: acs-test-new.example.com requestCount: type: integer description: The total number of requests to this endpoint within the time window. example: 1033 performance: type: object description: Information about latency percentile metrics. required: - p90LatencyMs - p95LatencyMs properties: p90LatencyMs: type: number description: The 90th-percentile response latency, in milliseconds. example: 43.736202 p95LatencyMs: type: number description: The 95th-percentile response latency, in milliseconds. example: 48.807 errors: type: object description: Information about the endpoint's errors. required: - totalErrors - errorRatePct - breakdown properties: totalErrors: type: integer description: The total number of 4xx and 5xx responses. example: 2 errorRatePct: type: number description: The percentage of requests that resulted in errors. example: 0.19 breakdown: type: object description: The error counts, keyed by the HTTP status code. additionalProperties: type: integer example: 2 collectionUid: type: string format: uid example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 apiCatalogServiceSortMonitorRun: type: string pattern: ^(timestamp|duration|failedAssertions):(asc|desc)$ example: failedAssertions:desc environmentId: type: string example: 5daabc50-8451-43f6-922d-96b403b4f28e apiCatalogServiceStatusFilter: type: string enum: - passed - failed example: passed apiCatalogServiceMetadataTotalRunsData: type: integer description: The total number of runs that match the given filters. example: 2 apiCatalogServiceMetadataPassedRunsData: type: integer description: The number of successful runs. example: 2 apiCatalogServiceMetadataFailedRunsData: type: integer description: The number of runs with at least one failure. example: 0 apiCatalogServiceMetadataSuccessRatePctData: type: number description: The percentage of runs that passed, rounded to two decimal places. example: 44.1 apiCatalogServiceCollectionData: type: object description: Information about the collection. required: - id - name properties: id: type: string description: The collection's ID. example: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: type: string nullable: true description: The collection's name. If the collection was deleted, this returns a null value. example: '[PROD] API Control Service' apiCatalogServiceEnvironmentData: type: object description: Information about the environment. required: - id - name properties: id: type: string description: The environment's ID. example: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: type: string nullable: true description: The environment's name. If the environment was deleted, this returns a null value. example: '[PROD] API Control Service' apiCatalogServicePerformanceData: type: object description: Information about the response time range across all requests in the run. required: - minResponseMs - maxResponseMs properties: minResponseMs: type: number description: The fastest individual response time, in milliseconds. example: 17 maxResponseMs: type: number description: The slowest individual response time, in milliseconds. example: 308 getApiCatalogServiceMonitorRuns: type: object required: - meta - data properties: meta: type: object description: The response's meta information for paginated results. required: - nextCursor - limit - filters - timeRange - totalRuns - passedRuns - failedRuns - successRatePct properties: nextCursor: $ref: '#/components/schemas/apiCatalogServiceMetadataNextCursorData' limit: $ref: '#/components/schemas/apiCatalogServiceMetadataLimitData' filters: $ref: '#/components/schemas/apiCatalogServiceMetadataFiltersData' timeRange: $ref: '#/components/schemas/apiCatalogServiceMetadataTimeRangeData' totalRuns: $ref: '#/components/schemas/apiCatalogServiceMetadataTotalRunsData' passedRuns: $ref: '#/components/schemas/apiCatalogServiceMetadataPassedRunsData' failedRuns: $ref: '#/components/schemas/apiCatalogServiceMetadataFailedRunsData' successRatePct: $ref: '#/components/schemas/apiCatalogServiceMetadataSuccessRatePctData' data: type: array description: A list of monitor runs. items: type: object required: - id - status - timestamp - collection - environment - summary - performance properties: id: type: string description: The monitor run's ID. example: 019d9ef1-4441-7d5d-892b-cf280e19c12d status: type: string description: Whether the monitor run passed or failed. enum: - passed - failed example: passed timestamp: type: string format: date-time description: The date and time at which the run completed. example: '2026-04-18T04:55:04.898Z' collection: $ref: '#/components/schemas/apiCatalogServiceCollectionData' environment: $ref: '#/components/schemas/apiCatalogServiceEnvironmentData' summary: type: object description: Information about the monitor run. required: - totalRequests - failedRequests - totalAssertions - failedAssertions - durationMs properties: totalRequests: type: integer description: The total number of HTTP requests executed in the run. example: 16 failedRequests: type: integer description: The number of requests that failed. example: 0 totalAssertions: type: integer description: The total number of test assertions evaluated. example: 56 failedAssertions: type: integer description: The number of failed assertions. example: 0 durationMs: type: integer description: The total execution duration, in milliseconds. example: 1747 performance: $ref: '#/components/schemas/apiCatalogServicePerformanceData' specId: type: string example: 73e15000-bc7a-4802-b80e-05fff18fd7f8 apiCatalogServiceSpecLintSeverityFilter: type: string enum: - info - warning - error example: warning apiCatalogServiceSortSpecLintFilter: type: string pattern: ^(timestamp|errorCount):(asc|desc)$ example: timestamp:asc apiCatalogServiceMetadataConformanceRatePctData: type: number description: The percentage of runs that passed, rounded to two decimal places. example: 100 getApiCatalogServiceSpecificationLints: type: object required: - meta - data properties: meta: type: object description: The response's meta information for paginated results. required: - nextCursor - limit - filters - timeRange - totalRuns - passedRuns - failedRuns - conformanceRatePct properties: nextCursor: $ref: '#/components/schemas/apiCatalogServiceMetadataNextCursorData' limit: $ref: '#/components/schemas/apiCatalogServiceMetadataLimitData' filters: $ref: '#/components/schemas/apiCatalogServiceMetadataFiltersData' timeRange: $ref: '#/components/schemas/apiCatalogServiceMetadataTimeRangeData' totalRuns: $ref: '#/components/schemas/apiCatalogServiceMetadataTotalRunsData' passedRuns: $ref: '#/components/schemas/apiCatalogServiceMetadataPassedRunsData' failedRuns: $ref: '#/components/schemas/apiCatalogServiceMetadataFailedRunsData' conformanceRatePct: $ref: '#/components/schemas/apiCatalogServiceMetadataConformanceRatePctData' data: type: array description: A list of API specification lint runs. items: type: object required: - specId - specName - specType - timestamp - status - issues properties: specId: type: string description: The API specification's ID. example: 4c2e5d66-dd5a-43ea-a669-112f16ad48b4 specName: type: string nullable: true description: The API specification's name. If the specification was deleted or its metadata is unavailable, this returns a null value. example: ACS E2E Spec specType: type: string nullable: true description: The API specification's type and version ID. If the metadata is unavailable, this returns a null value. example: OPENAPI:3.0 timestamp: type: string format: date-time description: The date and time at which the run completed. example: '2026-04-19T12:08:43.110Z' status: type: string description: Whether the lint run passed or failed. enum: - passed - failed example: passed issues: type: object description: Issue counts by severity level. required: - errors - warnings - info properties: errors: type: integer description: The number of error level issues found. example: 0 warnings: type: integer description: The number of warning level issues found. example: 15 info: type: integer description: The number of info level issues found. example: 0 apiCatalogServiceBranchFilter: type: string maxLength: 255 example: develop apiCatalogServiceWorkflowNameFilter: type: string maxLength: 255 example: E2E Tests apiCatalogServiceActorFilter: type: string maxLength: 100 example: taylor-lee apiCatalogServiceRepoNameFilter: type: string maxLength: 255 example: acs-catalog apiCatalogServiceRepoOwnerFilter: type: string maxLength: 100 example: acs-team apiCatalogServiceSortCiFilter: type: string pattern: ^(timestamp|duration):(asc|desc)$ example: duration:desc getApiCatalogServiceCiRuns: type: object required: - meta - data properties: meta: type: object description: The response's meta information for paginated results. required: - nextCursor - limit - filters - timeRange - totalRuns - passedRuns - failedRuns - successRatePct properties: nextCursor: $ref: '#/components/schemas/apiCatalogServiceMetadataNextCursorData' limit: $ref: '#/components/schemas/apiCatalogServiceMetadataLimitData' filters: $ref: '#/components/schemas/apiCatalogServiceMetadataFiltersData' timeRange: $ref: '#/components/schemas/apiCatalogServiceMetadataTimeRangeData' totalRuns: $ref: '#/components/schemas/apiCatalogServiceMetadataTotalRunsData' passedRuns: $ref: '#/components/schemas/apiCatalogServiceMetadataPassedRunsData' failedRuns: $ref: '#/components/schemas/apiCatalogServiceMetadataFailedRunsData' successRatePct: $ref: '#/components/schemas/apiCatalogServiceMetadataSuccessRatePctData' data: type: array description: A list of CI collection runs. items: type: object required: - id - status - timestamp - collection - environment - source - pipeline - execution - summary - performance properties: id: type: string description: The CI run's ID. example: 27ace2f7-5130-4405-8489-5ce1ebee322e status: type: string description: Whether the CI run passed or failed. enum: - passed - failed example: passed timestamp: type: string format: date-time description: The date and time at which the run completed. example: '2026-04-16T03:56:54.372Z' collection: $ref: '#/components/schemas/apiCatalogServiceCollectionData' environment: $ref: '#/components/schemas/apiCatalogServiceEnvironmentData' source: type: object description: Information about the Git source control for the CI run. required: - branch - commitSha - repo - pullRequest properties: branch: type: string nullable: true description: The Git branch's name. example: develop commitSha: type: string nullable: true description: The full Git commit SHA. example: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2 repo: type: object description: Information about the source repository. required: - name - owner - url properties: name: type: string nullable: true description: The repository's name. example: acs-catalog owner: type: string nullable: true description: The repository owner or organization. example: acs-team url: type: string nullable: true format: uri description: The repository's URL. example: https://github.com/acs-team/acs-catalog pullRequest: type: object nullable: true description: Information about the pull request. This returns null if the run wasn't triggered by a pull request. required: - number - title - status - author - baseBranch - headBranch properties: number: type: integer description: The pull request number. example: 42 title: type: string nullable: true description: The pull request's title. example: Add OAuth2 authentication status: type: string nullable: true description: The pull request's status. example: open author: type: string nullable: true description: The author of the pull request. example: taylor-lee baseBranch: type: string nullable: true description: The target branch of the pull request. example: develop headBranch: type: string nullable: true description: The pull request's source branch. example: feature/add-auth pipeline: type: object description: Information about the CI/CD pipeline. required: - provider - workflowName - workflowId - jobName - jobId - pipelineId - pipelineNumber - runAttempt - actor properties: provider: type: string nullable: true description: The CI provider. example: github-actions workflowName: type: string nullable: true description: The workflow or pipeline name. example: E2E Tests workflowId: type: string nullable: true description: The workflow ID. example: '30002' jobName: type: string nullable: true description: The job name in the workflow. example: run-tests jobId: type: string nullable: true description: The job's ID. example: null pipelineId: type: string nullable: true description: The pipeline run's ID. example: '30002' pipelineNumber: type: string nullable: true description: The pipeline run number. example: '101' runAttempt: type: integer nullable: true description: The attempt number for this run. example: 1 actor: type: string nullable: true description: The user or bot that triggered the run. example: taylor-lee execution: type: object nullable: true description: Information about the environment run. required: - cliVersion - system properties: cliVersion: type: string nullable: true description: The Postman CLI version. example: 1.29.5 system: type: object description: The system information about the execution run. This returns as null if unavailable. properties: os: type: string description: The operating system and kernel version. example: linux 5.15.0-1051-aws cpus: type: integer description: The number of CPU cores. example: 4 memoryMb: type: integer description: The available memory, in megabytes. example: 15746 summary: type: object description: Information about the CI run. required: - totalRequests - failedRequests - totalAssertions - failedAssertions - durationMs properties: totalRequests: type: integer description: The total number of HTTP requests executed in the run. example: 29 failedRequests: type: integer description: The number of requests that failed. example: 0 totalAssertions: type: integer description: The total number of test assertions evaluated. example: 97 failedAssertions: type: integer description: The number of failed assertions. example: 1 durationMs: type: integer description: Total execution duration in milliseconds. example: 12341 performance: $ref: '#/components/schemas/apiCatalogServicePerformanceData' systemEnvironmentProductionFilter: type: boolean example: true apiCatalogSystemEnvironmentsFiltersData: type: object description: The applied filters, if any. properties: isProduction: type: boolean description: If true, only production system environments were returned. example: true apiCatalogSystemEnvironmentsMetaData: type: object required: - total - nextCursor - limit description: The response's meta information for paginated results. properties: total: type: integer description: The number of records that match the defined criteria. example: 11 nextCursor: type: string nullable: true description: The pagination cursor that points to the next record in the results set. example: ZjA2MjRkN2QtMjI2MS00NTdlLTlmNzEtYTYyYjFkYTcxZWFh limit: type: integer description: The maximum number of records in the paginated response. example: 5 filters: $ref: '#/components/schemas/apiCatalogSystemEnvironmentsFiltersData' apiCatalogSystemEnvironmentData: type: object required: - id - name - label - color - description - isProduction - associationCount - createdAt - updatedAt description: Information about the system environment. properties: id: type: string description: The system environment's ID. example: fffa77cd-fd06-448e-a65d-2f77a0e58dad name: type: string description: The system environment's name. example: TESTING-1774258301513-4358-1 label: type: string description: A lowercase, terminal-friendly identifier for the system environment. example: '' color: type: string pattern: ^#[0-9A-Fa-f]{6}$ description: A six-digit hex color code. example: '#FF0000' description: type: string description: A description of the system environment. example: Testing environment. isProduction: type: boolean description: If true, the system environment is a production environment. example: false associationCount: type: integer description: The total number of workspace environments associated with this system environment. example: 0 createdAt: type: string format: date-time description: The date and time at which the system environment was created. example: '2026-03-23T09:31:41.000Z' updatedAt: type: string format: date-time description: The date and time at which the system environment was last updated. example: '2026-03-27T17:56:16.000Z' getApiCatalogSystemEnvironments: type: object required: - meta - data properties: meta: $ref: '#/components/schemas/apiCatalogSystemEnvironmentsMetaData' data: type: array description: A list of system environments. items: $ref: '#/components/schemas/apiCatalogSystemEnvironmentData' createApiCatalogSystemEnvironment: type: object required: - name - color properties: name: type: string minLength: 1 maxLength: 255 description: The system environment's name. This value must be unique within the team. example: ALPHA label: type: string maxLength: 50 pattern: ^[a-z0-9_-]+$ description: A lowercase, terminal-friendly identifier for the system environment. Accepts only alphanumeric characters, hyphens, and underscores. example: alpha description: type: string maxLength: 500 description: A description of the system environment. To remove a description, pass this value as an empty string. example: This is the ALPHA environment color: type: string pattern: ^#[0-9A-Fa-f]{6}$ description: A six-digit hex color code. example: '#00FF00' isProduction: type: boolean default: false description: If true, the system environment is a production environment. example: false postPatchApiCatalogSystemEnvironmentData: type: object description: Information about the system environment. required: - id - name - label - color - description - isProduction - createdAt - updatedAt properties: id: type: string description: The system environment's ID. example: 019d3dca-5e16-7bba-9f13-7abf00a6a443 name: type: string description: The system environment's name. example: ALPHA label: type: string description: A lowercase, terminal-friendly identifier for the system environment. example: alpha color: type: string pattern: ^#[0-9A-Fa-f]{6}$ description: A six-digit hex color code. example: '#00FF00' description: type: string description: A description of the system environment. example: This is the ALPHA environment isProduction: type: boolean description: If true, the system environment is a production environment. example: false createdAt: type: string format: date-time description: The date and time at which the system environment was created. example: '2026-03-30T08:09:25.781Z' updatedAt: type: string format: date-time description: The date and time at which the system environment was last updated. example: '2026-03-30T08:09:25.781Z' createApiCatalogSystemEnvironmentResponse: type: object required: - data properties: data: $ref: '#/components/schemas/postPatchApiCatalogSystemEnvironmentData' getApiCatalogSystemEnvironment: type: object required: - data properties: data: $ref: '#/components/schemas/apiCatalogSystemEnvironmentData' updateApiCatalogSystemEnvironment: type: object minProperties: 1 properties: name: type: string minLength: 1 maxLength: 255 description: The system environment's name. This value must be unique within the team. example: US-BETA description: type: string maxLength: 500 description: A description of the system environment. To remove a description, pass this value as an empty string. example: This is a beta environment for testing US data center. color: type: string pattern: ^#[0-9A-Fa-f]{6}$ description: A six-digit hex color code. example: '#FFFFFF' isProduction: type: boolean description: If true, the system environment is a production environment. example: false updateApiCatalogSystemEnvironmentResponse: type: object required: - data properties: data: $ref: '#/components/schemas/postPatchApiCatalogSystemEnvironmentData' systemEnvironmentWorkspaceId: type: string example: 47d1b387-2485-482a-bf62-46ddd70a6d1e getApiCatalogSystemEnvironmentAssociationsData: type: object required: - id - workspaceEnvironmentId - workspaceId - associatedAt description: Information about the workspace-environment association. properties: id: type: string description: The association's ID. example: ff53b4bc-eeb7-4b13-866a-5fbd79b13137 workspaceEnvironmentId: type: string description: The workspace environment's ID. example: 12345678-10ec194c-01eb-4844-91a2-9612fccf59d9 workspaceId: type: string description: The ID of the workspace that contains the environment. example: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: type: string format: date-time description: The date and time at which the association was created. example: '2026-03-17T09:48:14.000Z' getApiCatalogSystemEnvironmentAssociations: type: object required: - meta - data properties: meta: $ref: '#/components/schemas/apiCatalogSystemEnvironmentsMetaData' data: type: array description: A list of workspace-environment associations. items: $ref: '#/components/schemas/getApiCatalogSystemEnvironmentAssociationsData' systemEnvironmentAllowPartial: type: boolean default: false example: true workspaceEnvironmentIds: type: string pattern: ^[0-9]+-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ description: A workspace environment's unique ID (`userId`-`environmentId`). example: 12345678-4b076607-09cf-4f9d-8a9a-08c8f3cf4619 workspaceEnvironmentIdsData: type: array minItems: 1 maxItems: 25 description: A list of workspace environment unique IDs (`userId`-`environmentId`). items: $ref: '#/components/schemas/workspaceEnvironmentIds' addApiCatalogSystemEnvironmentAssociations: type: object required: - workspaceEnvironmentIds properties: workspaceEnvironmentIds: $ref: '#/components/schemas/workspaceEnvironmentIdsData' addApiCatalogSystemEnvironmentAssociationsMetaData: type: object required: - created - existing - replaced - excluded description: The response's meta information for paginated results. properties: created: type: integer description: The number of new associations created. example: 1 existing: type: integer description: The number of associations that already existed and were unchanged. example: 1 replaced: type: integer description: The number of associations that were moved from a different system environment. example: 1 excluded: type: integer description: The number of associations that were skipped. This only returns if you pass the `allowPartial` query parameter as `true`). example: 0 addApiCatalogSystemEnvironmentAssociationsData: type: object required: - workspaceEnvironmentId - status description: Information about the associated workspace environment. properties: id: type: string description: The association's unique ID. This value doesn't return if the item was excluded. example: 019d3e30-6768-7770-91f0-a2010c886619 workspaceEnvironmentId: type: string description: The workspace's environment ID. example: 12345678-4b076607-09cf-4f9d-8a9a-08c8f3cf4619 workspaceId: type: string description: The ID of the workspace that contains the environment. This value doesn't return if the item was excluded. example: 4540d410-ef72-4977-afb8-d7f53705f379 associatedAt: type: string format: date-time description: The date and time at which the association was created. This value doesn't return if the item was excluded. example: '2026-03-30T04:30:52.000Z' status: type: string enum: - created - existing - replaced - excluded description: | The association's status: - `created` — An association was created. - `existing` — The association already existed and is unchanged. - `replaced` — The association was moved from a different system environment. - `excluded` — The association was skipped. example: existing previousSystemEnvironmentId: type: string description: The system environment ID the association was moved from. This only returns when the status is `replaced`. example: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 reason: type: string description: The reason the association was excluded. This only returns when the status is `excluded`. example: Access denied addApiCatalogSystemEnvironmentAssociationsResponse: type: object required: - meta - data properties: meta: $ref: '#/components/schemas/addApiCatalogSystemEnvironmentAssociationsMetaData' data: type: array description: A list of the workspace-environment associations that were added. items: $ref: '#/components/schemas/addApiCatalogSystemEnvironmentAssociationsData' removeApiCatalogSystemEnvironmentAssociations: type: object required: - workspaceEnvironmentIds properties: workspaceEnvironmentIds: $ref: '#/components/schemas/workspaceEnvironmentIdsData' removeApiCatalogSystemEnvironmentAssociationsMetaData: type: object required: - deleted - notFound description: The response's meta information for paginated results. properties: deleted: type: integer description: The number of associations successfully removed. example: 1 notFound: type: integer description: The number of environment IDs with no existing association to remove. example: 1 removeApiCatalogSystemEnvironmentAssociationsData: type: object required: - workspaceEnvironmentId - status description: Information about the associated workspace environment. properties: workspaceEnvironmentId: type: string description: The workspace's environment ID. example: 12345678-4b076607-09cf-4f9d-8a9a-08c8f3cf4619 status: type: string enum: - deleted - notFound description: | The status of the operation: - `deleted` — The association was successfully removed. - `notFound` — The association could not be removed. example: deleted removeApiCatalogSystemEnvironmentAssociationsResponse: type: object required: - meta - data properties: meta: $ref: '#/components/schemas/removeApiCatalogSystemEnvironmentAssociationsMetaData' data: type: array description: A list of the workspace-environment associations that were removed. items: $ref: '#/components/schemas/removeApiCatalogSystemEnvironmentAssociationsData' workspaceId: type: string example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 v10Accept: type: string enum: - application/vnd.api.v10+json example: application/vnd.api.v10+json createdBy: type: integer example: 12345678 apiDescription: type: string example: This is an API for testing purposes limit: type: integer default: 10 example: 10 getApis: title: Get APIs type: object description: Information about the API schema. properties: apis: type: array description: A list of APIs. items: type: object description: The API's base data schema. properties: id: type: string description: The API's ID. example: 5360b75f-447e-467c-9299-12fd6c92450d name: type: string description: The API's name. example: User Management API summary: type: string description: The API's short summary. example: An API to manager users. createdAt: type: string format: date-time description: The date and time at which the API was created. example: '2023-08-22T14:21:57.000Z' createdBy: type: integer description: The Postman ID of the user that created the API. example: 12345678 updatedAt: type: string format: date-time description: The date and time at which the API was updated. example: '2023-08-22T14:21:57.000Z' updatedBy: type: integer description: The Postman ID of the user that updated the API. example: 12345678 description: type: string description: The API's description. example: This API includes operations to add/remove/update users. meta: type: object description: The response's meta information for paginated results. properties: limit: type: integer example: 100 description: The maximum number of records in the paginated response. total: type: integer example: 1000 description: The number of records that match the defined criteria. nextCursor: type: string format: base64 description: The pagination cursor that points to the next record in the results set. example: RnJpIEZlYiAyNCAyMDIzIDEzOjI0OjA5IEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk= commonErrorErrorObjTypeTitleDetail: title: Error (Type, Title, Detail) type: object properties: error: type: object description: Information about the error. properties: type: type: string description: The type of error. example: instanceNotFoundError title: type: string description: A short summary of the problem. example: Collection not found detail: type: string description: Details about the error. example: The API does not contain the collection you are looking for createUpdateApi: title: Create/Update API description: Information about the API. type: object required: - name properties: name: type: string description: The API's name. example: Test API summary: type: string description: The API's short summary. example: Testing API description: type: string description: The API's description. This supports Markdown formatting. example: This is a test API. createApiResponse: title: API Created type: object properties: id: type: string description: The API's ID. example: 5360b75f-447e-467c-9299-12fd6c92450d name: type: string description: The API's name. example: User Management API summary: type: string description: The API's short summary. example: An API to manager users. createdAt: type: string format: date-time description: The date and time at which the API was created. example: '2023-08-22T14:21:57.000Z' createdBy: type: integer description: The Postman ID of the user that created the API. example: 12345678 updatedAt: type: string format: date-time description: The date and time at which the API was updated. example: '2023-08-22T14:21:57.000Z' updatedBy: type: integer description: The Postman ID of the user that updated the API. example: 12345678 description: type: string description: The API's description. example: This API includes operations to add/remove/update users. commonErrorTypeTitleMessageDetail: title: Error (Type, Title, Message, Detail) type: object properties: type: type: string description: The type of error. example: limitReachedError title: type: string description: A short summary of the problem. example: You've reached the API limit message: type: string description: The error message. example: You can create up to 3 APIs on your current plan. detail: type: object description: Information about the error. additionalProperties: true apiId: type: string example: 90ca9f5a-c4c4-11ed-afa1-0242ac120002 apiInclude: type: array items: type: string enum: - collections - versions - schemas - gitInfo example: - schemas getApi: title: Get an API anyOf: - type: object title: API Data properties: id: type: string description: The API's ID. example: 5360b75f-447e-467c-9299-12fd6c92450d name: type: string description: The API's name. example: User Management API summary: type: string description: The API's short summary. example: An API to manager users. createdAt: type: string format: date-time description: The date and time at which the API was created. example: '2023-08-22T14:21:57.000Z' createdBy: type: integer format: int64 description: The Postman ID of the user that created the API. example: 12345678 updatedAt: type: string format: date-time description: The date and time at which the API was updated. example: '2023-08-22T14:21:57.000Z' updatedBy: type: integer format: int64 description: The Postman ID of the user that updated the API. example: 12345678 description: type: string description: The API's description. example: This API includes operations to add/remove/update users. - type: object title: Extended API Data description: | The API's extended data schema. **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. allOf: - type: object title: API Base Data description: The API's base data schema. properties: id: type: string description: The API's ID. example: 5360b75f-447e-467c-9299-12fd6c92450d name: type: string description: The API's name. example: User Management API summary: type: string description: The API's short summary. example: An API to manager users. createdAt: type: string format: date-time description: The date and time at which the API was created. example: '2023-08-22T14:21:57.000Z' createdBy: type: integer format: int64 description: The Postman ID of the user that created the API. example: 12345678 updatedAt: type: string format: date-time description: The date and time at which the API was updated. example: '2023-08-22T14:21:57.000Z' updatedBy: type: integer format: int64 description: The Postman ID of the user that updated the API. example: 12345678 description: type: string description: The API's description. example: This API includes operations to add/remove/update users. - type: object title: API Details properties: gitInfo: type: object title: Git Repo Data Schema description: Information about the API's Git repository integration. properties: domain: type: string nullable: true description: The domain at which the Git repository is hosted. example: https://git.example.com repository: type: string description: The repository's name. example: test-api-repo organization: type: string description: The organization that owns the repository. example: test-org schemaFolder: type: string description: The API definition's repository folder location. example: test-api-schema collectionFolder: type: string description: The API definition's collection repository folder location. example: test-api-collection schemas: type: array description: The API's schemas. items: type: object description: Information about the schema. properties: id: type: string description: The schema's ID. example: 5381f010-c4c1-11ed-afa1-0242ac120002 versions: type: array description: The API's versions. items: type: object description: Information about the version. properties: id: type: string description: The version's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: type: string description: The version's name. example: v1 collections: type: array description: The API's collections. items: type: object description: Information about the collection. properties: id: type: string description: The collection's ID. example: 12345678-61867bcc-c4c1-11ed-afa1-0242ac120002 apiErrorNameMessage: title: API Error (Name, Message) type: object properties: name: type: string description: The error name. example: instanceNotFoundError message: type: string description: The error message. example: API not found. For v10 and later APIs, ensure that your request sends the "application/vnd.api.v10+json" Accept header. updateApiResponse: title: Update API Response type: object required: - name properties: id: type: string description: The API's ID. example: 5360b75f-447e-467c-9299-12fd6c92450d name: type: string description: The API's name. example: Test API A summary: type: string description: The API's summary. example: Test API A Schema createdAt: type: string format: date-time description: The date and time at which the API was created. example: '2022-06-29T20:46:58.000Z' createdBy: type: string description: The user ID of the user that created the API. example: '12345678' updatedAt: type: string format: date-time description: The date and time at which the API was last updated. example: '2022-06-29T20:46:58.000Z' updatedBy: type: string description: The user ID of the user that updated the API. example: '12345678' description: type: string description: The API's description. This supports Markdown formatting. example: This is Test API A. copyCollectionToApi: title: Copy Collection to API type: object properties: data: type: object description: Information about the copied collection. properties: collectionId: type: string description: The collection ID to copy to the API. example: 12345678-61867bcc-c4c1-11ed-afa1-0242ac120002 operationType: type: string description: The `COPY_COLLECTION` method. enum: - COPY_COLLECTION example: COPY_COLLECTION createApiCollection: title: Create API Collection type: object properties: data: type: object description: Information about the collection's contents, such as requests and responses. For a complete list of values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). properties: info: type: object description: Information about the collection. properties: name: type: string description: The collection's name. example: Sample collection schema: type: string format: url description: The collection's schema format. enum: - https://schema.postman.com/json/collection/v2.1.0/collection.json example: https://schema.postman.com/json/collection/v2.1.0/collection.json item: type: array description: Information about the requests and responses in the collection. For a complete list of values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). items: {} operationType: type: string description: The `CREATE_NEW` method. enum: - CREATE_NEW example: CREATE_NEW generateApiFromSchema: title: Generate from Schema type: object properties: name: type: string description: The collection's name. example: Sample collection operationType: type: string description: The `GENERATE_FROM_SCHEMA` method. enum: - GENERATE_FROM_SCHEMA example: GENERATE_FROM_SCHEMA options: type: object additionalProperties: true description: The advanced creation options for collections and their values. For a complete list of properties and their values, see Postman's [OpenAPI to Postman Collection Converter OPTIONS documentation](https://github.com/postmanlabs/openapi-to-postman/blob/develop/OPTIONS.md). These properties are case-sensitive. addApiCollectionResponse: title: API Collection Added type: object properties: id: type: string description: The collection's ID. example: 12345678-61867bcc-c4c1-11ed-afa1-0242ac120002 collectionIdApi: type: string format: uid example: 12345678-61867bcc-c4c1-11ed-afa1-0242ac120002 apiVersionId: type: string example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 getApiCollection: title: Get API Collection type: object additionalProperties: true properties: item: type: array description: A list of the collection's contents. items: type: object additionalProperties: true description: Information about the collection's contents. For a complete list of values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). info: type: object additionalProperties: true description: Information about the collection. properties: name: type: string description: The collection's name. example: Test Collection schema: type: string format: url description: A URL to the collection's schema. example: https://schema.postman.com/json/collection/v2.1.0/collection.json _postman_id: type: string description: The collection's Postman ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 description: type: string description: The collection's description. example: This is a test collection that makes a tiny request to Postman Echo service to get the list of request headers sent by a HTTP client. auth: type: object additionalProperties: true description: The collection's auth information. For a complete list of values, refer to the **Auth** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). variable: type: array description: A list of the collection's variables. items: type: object additionalProperties: true description: The collection's variable information. For a complete list of values, refer to the **Variable List** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). commentData: type: object title: Comment Data description: Information about the comment. properties: id: type: integer description: The comment's ID. example: 46814 threadId: type: integer description: The comment's thread ID. example: 12345 status: type: string description: The comment's current status. enum: - Open - Resolved example: Open createdBy: type: integer description: The user ID of the user who created the comment. example: 12345678 createdAt: type: string format: date-time description: The date and time at which the comment was created. example: '2024-01-18T11:30:40.000Z' updatedAt: type: string format: date-time description: The date and time when the comment was last updated. example: '2024-01-18T11:30:40.000Z' body: type: string description: The contents of the comment. example: This is an example. commentResponse: title: Comment Response Object type: object properties: data: type: array description: A list of comments. required: - id - threadId - status - createdBy - createdAt - updatedAt - body items: $ref: '#/components/schemas/commentData' commentTaggedUsers: type: object title: Tagged Users description: Information about users tagged in the `body` comment. properties: '{{userName}}': type: object required: - type - id description: An object that contains information about the tagged user. The object's name is the user's Postman username. For example, `@user-postman`. properties: type: type: string description: The `user` value. enum: - user example: user id: type: string description: The user's ID. example: '87654321' commentCreate: title: Comment Create type: object description: Information about the comment. required: - body properties: body: type: string description: The contents of the comment. example: This is an example. threadId: type: integer description: The comment's thread ID. To create a reply on an existing comment, include this property. example: 12345 tags: $ref: '#/components/schemas/commentTaggedUsers' commentCreatedUpdated: title: Comment Updated/Created Object type: object properties: data: type: object description: Information about the created or updated comment. properties: id: type: integer description: The comment's ID. example: 46814 threadId: type: integer description: The comment's thread ID. example: 12345 createdBy: type: integer description: The user ID of the user who created the comment. example: 12345678 createdAt: type: string format: date-time description: The date and time at which the comment was created. example: '2024-01-18T11:30:40.000Z' updatedAt: type: string format: date-time description: The date and time when the comment was last updated. example: '2024-01-18T11:30:40.000Z' body: type: string description: The contents of the comment. example: This is an example. commentId: type: integer example: 46814 commentUpdate: title: Comment Update type: object description: Information about the comment. required: - body properties: body: type: string description: The contents of the comment. example: This is an example. tags: $ref: '#/components/schemas/commentTaggedUsers' syncCollectionWithSchemaResponse: title: Sync Collection with Schema Response type: object properties: taskId: type: string example: 66ae9950-0869-4e65-96b0-1e0e47e771af description: The created task ID. You can use this ID to track the status of syncing an API collection with an API schema. createApiSchema: title: Create API Schema description: Information about the API schema. type: object required: - type - files properties: type: type: string description: The schema's type. enum: - proto:2 - proto:3 - graphql - openapi:3_1 - openapi:3 - openapi:2 - openapi:1 - raml:1 - raml:0_8 - wsdl:2 - wsdl:1 - asyncapi:2 example: openapi:3 files: type: array description: The list of files that are part of the schema. items: type: object properties: path: type: string description: The schema's file path. example: index.json root: type: object description: Information about the schema's root file. properties: enabled: type: boolean default: true description: If true, tag the file as the root file. You can only update the root tag for protobuf specifications. example: true content: type: string description: The schema file's stringified contents. createApiSchemaResponse: type: object description: Information about the API schema. properties: id: type: string description: The schema's ID. example: b4fc1bdc-6587-4f9b-95c9-f768146089b4 type: type: string description: The schema's type. enum: - proto:2 - proto:3 - graphql - openapi:3_1 - openapi:3 - openapi:2 - openapi:1 - raml:1 - raml:0_8 - wsdl:2 - wsdl:1 - asyncapi:2 example: openapi:3 files: type: array description: A list of the schema's files. items: type: object description: Information about the schema file. properties: id: type: string description: The schema file's ID. example: b4fc1bdc-6587-4f9b-95c9-f768146089b4 name: type: string description: The schema file's name. example: index.json path: type: string description: The file system path to the schema file. example: index.json createdAt: type: string format: date-time description: The date and time at which the file was created. example: '2023-03-29T11:37:15Z' root: type: object description: An object that contains root file information. properties: enabled: type: boolean description: If true, the file is tagged as the schema's root file. The root tag is only allowed for protobuf specifications. example: true createdBy: type: string description: The user ID of the user that created the file. example: '12345678' updatedAt: type: string format: date-time description: The date and time at which the file was last updated. example: '2023-03-29T11:37:15Z' updatedBy: type: string description: The user ID of the user that last updated the file. example: '12345678' createdAt: type: string format: date-time description: The date and time at which the schema was created. example: '2023-03-29T11:37:15Z' createdBy: type: string description: The user ID of the user that created the schema. example: '12345678' updatedAt: type: string format: date-time description: The date and time at which the schema was last updated. example: '2023-03-29T11:37:15Z' updatedBy: type: string description: The user ID of the user that updated the schema. example: '12345678' apiSchemaId: type: string example: 5381f010-c4c1-11ed-afa1-0242ac120002 apiSchemaOutput: type: boolean default: false example: true getApiSchema: title: Get API Schema anyOf: - type: object title: Get Schema description: Information about the schema. properties: id: type: string description: The schema's ID. example: ae2b9ab2-28f2-401d-912f-eca09a78e98b type: type: string description: The schema's type. example: openapi:3 files: type: object description: Information about the schema's files. The response is paginated and limited to one page. properties: data: type: array description: A list of the schema files. items: title: Schema File Base Data description: Information about the schema file. type: object properties: id: type: string description: The schema file's ID. example: cf98c187-17c1-455f-afbf-d4be51f12770 name: type: string description: The schema file's name. example: s1.json path: type: string description: The file system path to the schema file. example: dir/s1.json createdAt: type: string format: date-time description: The date and time at which the file was created. example: '2023-03-16T18:38:56.000Z' createdBy: type: string description: The user ID of the user that created the file. example: '5000842' updatedAt: type: string format: date-time description: The date and time at which the file was last updated. example: '2023-03-16T19:11:24.000Z' updatedBy: type: string description: The user ID of the user that last updated the file. example: '5000842' meta: type: object description: The response's non-standard meta information. properties: nextPath: type: string description: The URL path to the next file. example: /apis/1fdbff7c-036b-4f8a-91bc-17bf3ae74fd2/schemas/cf98c187-17c1-455f-afbf-d4be51f12770/files?cursor=eyJzY2hlbWUiOiJwYXRoX2FzYyIsImRpcmVjdGlvblR5cGUiOiJuZXh0IiwicGl2b3QiOiJwYXRoIiwidmFsdWUiOiJkaXIvczEuanNvbiJ9 createdAt: type: string format: date-time description: The date and time at which the schema was created. example: '2022-03-29T11:37:15Z' createdBy: type: string description: The user ID of the user that created the schema. example: '12345678' updatedAt: type: string format: date-time description: The date and time at which the schema was last updated. example: '2022-03-29T11:37:15Z' updatedBy: type: string description: The user ID of the user that last updated the schema. example: '12345678' - type: object title: Get Bundled Schema description: Information about the schema. properties: id: type: string description: The schema's ID. example: ae2b9ab2-28f2-401d-912f-eca09a78e98b type: type: string description: The schema's type. example: openapi:3 createdBy: type: string description: The user ID of the user that created the schema. example: '12345678' updatedBy: type: string description: The user ID of the user that last updated the schema. example: '12345678' createdAt: type: string format: date-time example: '2022-03-29T11:37:15Z' description: The date and time at which the schema was created. updatedAt: type: string format: date-time description: The date and time at which the schema was last updated. example: '2022-03-29T11:37:15Z' content: type: string description: The schema file, in a bundled format. example: |- openapi: '3.0.0' info: version: '1.0.0' title: 'Sample API' description: Buy or rent spacecrafts paths: /spacecrafts/{spacecraftId}: parameters: - name: spacecraftId description: The unique identifier of the spacecraft in: path required: true schema: $ref: '#/components/schemas/SpacecraftId' get: summary: Read a spacecraft responses: '200': description: The spacecraft corresponding to the provided `spacecraftId` content: application/json: schema: $ref: '#/components/schemas/Spacecraft' 404: description: No spacecraft found for the provided `spacecraftId` content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: SpacecraftId: description: The unique identifier of a spacecraft type: string Spacecraft: type: object required: - id - names - type properties: id: $ref: '#/components/schemas/SpacecraftId' name: type: string type: type: string enum: - capsule - probe - satellite - spaceplane - station description: type: string Error: type: object required: - message properties: message: description: A human readable error message type: string securitySchemes: ApiKey: type: apiKey in: header name: X-Api-Key security: - ApiKey: [] getApiSchemaFiles: title: API Schema Files type: object properties: meta: type: object description: The schema's non-standard meta information. properties: nextCursor: type: string description: The pointer to the next record in the set of paginated results. example: eyJzY2hlbWUiOiJwYXRoX2FzYyIsImRpcmVjdGlvblR5cGUiOiJuZXh0IiwicGl2b3QiOiJwYXRoIiwidmFsdWUiOiJOZXdQZXQuanNvbiJ9 files: type: array description: A list of the schema's files. items: type: object title: Schema File Base Data description: Information about the schema file. properties: id: type: string description: The schema file's ID. example: e8a015e0-f472-4bb3-a523-57ce7c4583ed name: type: string description: The schema file's name. example: error.yaml path: type: string description: The file system path to the schema file. example: data-model/error.yaml createdAt: type: string format: date-time description: The date and time at which the file was created. example: '2022-03-29T11:37:15Z' createdBy: type: integer format: int64 description: The user ID of the user that created the file. example: 12345678 updatedAt: type: string format: date-time description: The date and time at which the file was last updated. example: '2022-03-29T11:37:15Z' updatedBy: type: integer description: The user ID of the user that last updated the file. example: 12345678 file-path: type: string example: postman/collection/c1.json getApiSchemaFileContents: title: Schema File Contents type: object properties: id: type: string description: The schema file's ID. example: 0784657a-668d-4530-85c8-468becdb06fd name: type: string description: The schema file's name. example: index.json path: type: string description: The file system path to the schema file. example: common/Test.json content: type: string description: The schema file's stringified contents. example: |- openapi: '3.0.0' info: version: '1.0.0' title: 'Sample API' description: Buy or rent spacecrafts paths: /spacecrafts/{spacecraftId}: parameters: - name: spacecraftId description: The unique identifier of the spacecraft in: path required: true schema: $ref: '#/components/schemas/SpacecraftId' get: summary: Read a spacecraft responses: '200': description: The spacecraft corresponding to the provided `spacecraftId` content: application/json: schema: $ref: '#/components/schemas/Spacecraft' 404: description: No spacecraft found for the provided `spacecraftId` content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: SpacecraftId: description: The unique identifier of a spacecraft type: string Spacecraft: type: object required: - id - names - type properties: id: $ref: '#/components/schemas/SpacecraftId' name: type: string type: type: string enum: - capsule - probe - satellite - spaceplane - station description: type: string Error: type: object required: - message properties: message: description: A human readable error message type: string securitySchemes: ApiKey: type: apiKey in: header name: X-Api-Key security: - ApiKey: [] createdAt: type: string format: date-time description: The date and time at which the file was created. example: '2023-03-15T13:27:45.000Z' createdBy: type: string description: The user Id of the user that created the file. example: '12345678' updatedAt: type: string format: date-time description: The date and time at which the file was last updated. example: '2023-03-15T13:27:45.000Z' updatedBy: type: string description: The user ID of the user that last updated the file. example: '12345678' createUpdateApiSchemaFile: title: Create/Update API Schema File description: Information about schema file. type: object properties: name: type: string description: The schema file's name. example: index.json root: type: object description: Information about the schema's root file. properties: enabled: type: boolean description: If true, tag the file as the root file. You can only update the root tag for protobuf specifications. example: true content: type: string description: The schema file's stringified contents. example: |- { "openapi": "3.1.0", "info": { "version": "1.0.0", "title": "Sample API", "description": "Buy or rent spacecrafts" }, "paths": { "/spacecrafts/{spacecraftId}": { "parameters": [ { "name": "spacecraftId", "description": "The unique identifier of the spacecraft", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SpacecraftId" } } ], "get": { "summary": "Read a spacecraft", "responses": { "200": { "description": "The spacecraft corresponding to the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Spacecraft" } } } }, "404": { "description": "No spacecraft found for the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "#/components/schemas/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key" } } }, "security": [ { "ApiKey": [ ] } ] } createUpdateApiSchemaFileResponse: title: Create/Update API Schema File Response type: object description: Information about the schema file. properties: createdBy: type: string description: The user ID of the user that created the file. example: '12345678' createdAt: type: string format: date-time description: The date and time at which the file was created. example: '2024-07-18T13:48:28.000Z' root: type: object description: Information about the schema's root file. properties: enabled: type: boolean description: If true, the file is the schema's the root file. example: true name: type: string description: The schema file's name. example: index.json path: type: string description: The file system path to the schema file. example: index.json updatedBy: type: string description: The user ID of the user that last updated the file. example: '12345678' id: type: string description: The schema file's ID. example: 2fdc8ea1-d02e-4e50-989e-6fa28f42b995 updatedAt: type: string format: date-time description: The date and time at which the file was last updated. example: '2024-07-18T13:48:28.000Z' getMigrationStatusDetails: description: Information about the migration's outcome (either a success payload or a failure reason). anyOf: - type: object description: Information about the migration. title: Successful Migration properties: workspaceId: type: string description: The ID of the workspace the definition was migrated to. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 - type: object description: Information about the migration. title: Migration Failed properties: reason: type: string description: The reason the migration failed. example: Moving to Spec Hub failed. Please try again or contact support. getMigrationStatus: type: object properties: status: type: string description: The status of the migration. enum: - COMPLETED - FAILED example: COMPLETED details: $ref: '#/components/schemas/getMigrationStatusDetails' getMigrationStatus400Error: type: object properties: error: type: object description: Information about the error. properties: name: type: string description: The error name. example: invalidParamsError message: type: string description: The error message. example: The specified parameter is in an invalid format details: type: object additionalProperties: true description: Information about the error. migrateApiToSpecHubExistingWorkspace: type: object title: Migrate to Existing Workspace required: - workspaceId properties: workspaceId: type: string description: The ID of an existing workspace to migrate the definition to. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 migrateApiToSpecHubNewWorkspace: type: object title: Migrate to New Workspace required: - workspaceInfo properties: workspaceInfo: type: object required: - name description: Information about the new workspace. properties: name: type: string description: The name of the workspace to create and migrate the definition to. example: API Workspace migrateGitConnectedApiToSpecHub: type: object title: Migrate Git-Connected Mono-Repo to New Workspace required: - workspaceInfo - gitInfo properties: workspaceInfo: type: object required: - name description: Information about the new workspace. properties: name: type: string description: The name of the workspace to create and migrate the definition to. example: API Workspace gitInfo: type: object required: - path description: Information about the connected remote Git mono-repo. properties: path: type: string description: The directory path in the remote mono-repo containing the API's collections and definitions. This property expects an absolute path and only contains alphanumeric characters, slashes, hyphens, underscores, and periods. It cannot contain path traversal sequences (\..\). example: /spaceships migrateApiToSpecHub: anyOf: - $ref: '#/components/schemas/migrateApiToSpecHubExistingWorkspace' - $ref: '#/components/schemas/migrateApiToSpecHubNewWorkspace' - $ref: '#/components/schemas/migrateGitConnectedApiToSpecHub' migrateToSpecHubResponse: type: object properties: message: type: string description: The operation's message. example: Moving to Spec Hub started successfully success: type: boolean description: If true, the migration succeeded. example: true migrateApiToSpecHub400ErrorTitleMessage: type: object title: Error (Title, Message) properties: error: type: object description: Information about the error. properties: title: type: string description: A short summary of the problem. example: Definition type not supported message: type: string description: The error message. example: 'This API contains an unsupported definition type wsdl:1.0. Spec Hub supports: OAS3, OAS3.1, OAS2.0, AsyncAPI2.0, graphQl, gRPC.' migrateApiToSpecHub400ErrorTitleMessageDetails: type: object title: Error (Title, Details, Message) properties: error: type: object description: Information about the error. properties: title: type: string description: A short summary of the problem. example: Moving to Spec Hub not possible details: type: object description: Information about the error. properties: workspaceId: type: string description: The workspace's ID. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 message: type: string description: The error message. example: The git repository is already linked to another workspace. Please reach out to Postman support for assistance. migrateApiToSpecHub400ErrorTypeNameMessageTitle: type: object title: Error (Type, Name, Message, Title) properties: error: type: object description: Information about the error. properties: type: type: string description: A short summary of the problem. example: badRequest name: type: string description: The error name. example: invalidGitInfoPath message: type: string description: The error message. example: The provided path is invalid. It must be an absolute path starting with \\, contain only alphanumeric characters, slashes, hyphens, underscores, and dots, and must not contain \\..\\ path traversal sequences. title: type: string description: A short summary of the problem. example: Invalid path parameter tagSlug: type: string pattern: ^[a-z][a-z0-9-]*[a-z0-9]+$ minLength: 2 maxLength: 64 description: The tag's ID within a team or individual (non-team) user scope. example: needs-review tagData: type: object description: Information about the tag. required: - slug properties: slug: $ref: '#/components/schemas/tagSlug' tagGetPut: title: Success Response type: object properties: tags: type: array maxItems: 5 minItems: 0 description: A list of associated tags. items: $ref: '#/components/schemas/tagData' tagUpdateTags: title: Update Tags type: object required: - tags properties: tags: type: array minItems: 0 maxItems: 5 description: A list of the associated tags as slugs. items: $ref: '#/components/schemas/tagSlug' tag400Error: title: Bad Request type: object properties: title: type: string description: A short summary of the problem. example: Bad Request detail: type: string description: Information about the error. example: body/tags/0/slug must NOT have more than 64 characters status: type: integer format: http-status-code description: The error's HTTP status code. example: 400 apiTaskId: type: string example: 90ca9f5a-c4c4-21ed-afa1-0242ac120002 getStatusOfAnAsyncApiTask: title: Get Async Task Status type: object properties: id: type: string description: The task's ID. example: 10ca9f5a-c4c4-11ed-afa1-0242ac120002 meta: type: object description: The response's non-standard meta information. properties: url: type: string format: url description: The endpoint URL that created the task. example: https://api.postman.com/apis/5360b75f-447e-467c-9299-12fd6c92450d/collections/e726de58-f1b3-4edd-a8a7-2579dc799d39/sync model: type: string description: The model for which the task is performing the operation. enum: - collection - api-version example: collection action: type: string description: The task's action. enum: - update - create example: update status: description: The task's current status. enum: - pending - failed - completed type: string example: completed details: description: Information about the task's outcome (either the resources it produced or the error that stopped it). anyOf: - type: object title: Task Resources description: Information about the task's resources. properties: resources: type: array description: A list of the resources the task produced. items: type: object properties: id: type: string description: The ID of the assigned resource. example: collectionID url: type: string description: The task's assigned resource URL. example: https://api.postman.com/apis/5360b75f-447e-467c-9299-12fd6c92450d/collections/e726de58-f1b3-4edd-a8a7-2579dc799d39 - type: object title: Task Error Information description: Information about the error that occurred during the task's processing. properties: error: type: object description: Information about the error. properties: message: type: string description: The task's error message. example: The API contains invalid schema createdAt: type: string format: date-time description: The date and time at which the task was created. example: '2023-08-22T14:21:57.000Z' updatedAt: type: string format: date-time description: The date and time at which the task was last updated. example: '2023-08-22T14:21:57.000Z' getApiVersions: title: Get API Versions type: object properties: meta: type: object description: The response's meta information for paginated results. properties: limit: type: integer description: The maximum number of records in the paginated response. example: 100 total: type: integer description: The number of records that match the defined criteria. example: 1000 nextCursor: type: string format: base64 description: The pagination cursor that points to the next record in the results set. example: VGh1IE1hciAxNiAyMDIzIDE3OjIxOjUzIEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk= versions: type: array description: A list of the API's versions. items: type: object title: API Version Data Schema description: Information about the API version. properties: id: type: string description: The version's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: type: string description: The version's name. example: Release 1.0 createdAt: type: string format: date-time description: The date and time at which the version was created. example: '2023-06-09T14:48:45.000Z' updatedAt: type: string format: date-time description: The date and time at which the version was last updated. example: '2023-06-09T14:48:45.000Z' releaseNotes: type: string description: The version's release notes. example: This is the first release. createGitUnlinkedVersionSchema: title: Create Version Schema (Not Git-Linked) description: Information about the API version. type: object required: - name - schemas - collections properties: name: type: string description: The version's name. example: v1 schemas: type: array description: A list of the version's schemas. items: type: object description: Information about the schema. properties: id: type: string description: The schema's ID. example: 5381f010-c4c1-11ed-afa1-0242ac120002 collections: type: array description: A list of the version's collections. items: type: object description: Information about the collection. properties: id: type: string description: The collection's ID. example: 123456-12ece9e1-2abf-4edc-8e34-de66e74114d2 releaseNotes: type: string description: Information about the API version release. For example, changelog notes. example: This is the first release. createGitLinkedVersion: title: Create Version Schema (Git-Linked) description: Information about the API version. type: object required: - name - branch - schemas - collections properties: name: type: string description: The version's name. example: v1 branch: type: string description: The branch ID. example: main schemas: type: array description: A list of the version's schemas. items: type: object description: Information about the schema. properties: directoryPath: type: string description: The path to the root directory where schemas are stored in the Git repository. example: postman/schemas collections: type: array description: A list of the version's collections. items: type: object description: Information about the collection. properties: filePath: type: string description: The path to the collection in the Git repository. example: postman/collection/c1.json releaseNotes: type: string example: This is the first release. description: Information about the API version release. For example, changelog notes. createGitLinkedVersionRootFile: title: Create Version Schema (Git-Linked with root File) description: Information about the API version. type: object required: - name - branch - schemas - collections properties: name: type: string description: The version's name. example: v1 branch: type: string description: The branch ID. example: develop schemas: type: array description: A list of the version's schemas. items: type: object description: Information about the schema. properties: filePath: type: string description: The path to the schema root file in the Git repository. example: index.yaml collections: type: array description: A list of the version's collections. items: type: object description: Information about the collection. properties: filePath: type: string description: Path to a collection in the Git repository. example: postman/collection/c1.json releaseNotes: type: string description: Information about the API version release. For example, changelog notes. example: This is the first release. createApiVersionResponse: title: API Version Created type: object properties: id: type: string description: The version's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 createdAt: type: string format: date-time description: The date and time at which the version was created. example: '2023-06-09T14:48:45.000Z' updatedAt: type: string format: date-time description: The date and time at which the version was last updated. example: '2023-06-09T19:50:49.000Z' name: type: string description: The version's name. example: v1 releaseNotes: type: string description: Information about the API version release. For example, changelog notes. example: This is the first release. getApiVersion: title: API Version type: object properties: version: type: object description: Information about the API version. properties: id: type: string description: The version's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: type: string description: The version's name. example: Release 1.0 createdAt: type: string format: date-time description: The date and time at which the version was created. example: '2023-06-09T14:48:45.000Z' updatedAt: type: string format: date-time description: The date and time at which the version was last updated. example: '2023-06-09T14:48:45.000Z' releaseNotes: type: string description: The version's release notes. example: This is the first release. schemas: type: array description: A list of the API's schemas. items: type: object description: Information about the schema. properties: id: type: string description: The schema's ID. example: 13a441a3-6109-4f78-86eb-e0144d0ff275 type: type: string description: The schema type. example: openapi:3 collections: type: array description: A list of the API's collections. items: type: object description: Information about the collection. properties: id: type: string description: The collection's ID. example: aeedb353-494b-4424-82cf-358aece2bd1c type: type: string description: The collection's name. example: collection1 updateApiVersion: title: Update API Version description: Information about the API version. type: object required: - name properties: name: type: string description: The version's name. example: Release 1.5 releaseNotes: type: string description: The version's Markdown-supported release notes. example: This is the first public release update. updateApiVersionResponse: title: API Version Updated type: object description: Information about the API version. properties: id: type: string description: The version's ID. example: 8d7ba74e-2c36-4e36-a263-f3c0c9ae21d2 name: type: string description: The version's name. example: Release 1.5 createdAt: type: string format: date-time description: The date and time at which the version was created. example: '2022-06-09T14:48:45.000Z' updatedAt: type: string format: date-time description: The date and time at which the version was last updated. example: '2022-06-09T19:50:49.000Z' releaseNotes: type: string description: The version's release notes. example: This is the first public release update. auditLogsUserIdQuery: type: integer example: 12345678 auditLogsActionQuery: type: string example: team.scim_add_member sinceDateQuery: type: string format: date example: '2022-08-30' untilDateQuery: type: string format: date example: '2022-09-15' auditLogsLimitQuery: type: integer maximum: 300 example: 50 ascDescDefaultDesc: type: string default: desc enum: - asc - desc example: desc auditLogActor: type: object description: Information about the user who preformed the audit event. properties: name: type: string description: The user's name. example: Taylor Lee username: type: string description: The user's username. example: taylor-lee email: type: string format: email description: The user's email address. example: taylor.lee@example.com id: type: number description: The user's ID. example: 12345678 active: type: boolean description: If true, the user is active. If false, the user is deactivated. example: true auditLogUser: type: object description: Information about the user. properties: name: type: string description: The user's name. example: Taylor Lee username: type: string description: The user's username. example: taylor-lee email: type: string format: email description: The user's email address. example: taylor.lee@example.com id: type: number description: The user's ID. example: 12345678 auditLogTeam: type: object description: The user's team information. properties: name: type: string description: The team's name. example: Test-Team id: type: number description: The team's ID. example: 1234 auditLogData: type: object description: Information about the audit log. properties: actor: $ref: '#/components/schemas/auditLogActor' user: $ref: '#/components/schemas/auditLogUser' team: $ref: '#/components/schemas/auditLogTeam' variables: type: object description: Additional information about the performed action. additionalProperties: true auditLogEvent: type: object description: Information about the audit log event. properties: id: type: number description: The audit event's ID. example: 12345678 ip: type: string nullable: true description: The IP address of the user that performed the action. example: 192.0.2.0 userAgent: type: string nullable: true description: The user agent information. example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36 action: type: string description: The action performed by the user. example: user.login_google_success timestamp: type: string format: date-time description: The date and time at which the event occurred. example: '2022-08-31T15:19:32.000Z' message: type: string description: The audit event's description. example: Taylor Lee successfully logged in using the Google OAuth. data: $ref: '#/components/schemas/auditLogData' getAuditLogs: type: object properties: trails: type: array description: A list of audit log events. items: $ref: '#/components/schemas/auditLogEvent' auditLogAction: type: object description: Information about the audit log event action. properties: code: type: string description: The audit log event action's code. example: team.invoice_paid name: type: string description: The audit log event action's display name as it appears in Postman's Audit Logs dashboard. example: Invoice Paid getAuditLogEventActions: title: Audit Log Events type: object properties: data: type: array description: A list of available audit log event actions. items: $ref: '#/components/schemas/auditLogAction' collectionUidQuery: type: string format: uid example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 getCollectionAccessKeys: title: Collection Access Keys type: object properties: data: type: array description: A list of collection access keys. items: type: object description: Information about the collection access key. properties: id: type: string description: The collection access key's ID. example: Njg5OjU3MDQ1NjYtYmQxZDU3NzktMWVkNS00ZDhjLWI0ZmQtZWRhOGY2Mzg1NTY0 token: type: string description: The masked collection access key. example: PMAT-**********************43BR status: type: string description: The token's active status. enum: - ACTIVE - INACTIVE example: ACTIVE teamId: type: integer description: The team ID of the collection access key's owner. example: 123 userId: type: integer description: The user ID of the collection access key's owner. example: 12345678 collectionId: type: string format: uid description: The collection access key's associated collection ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 expiresAfter: type: string format: date-time description: The date and time at which the collection access key expires. Collection access keys are valid for 60 days. If unused, the access key expires after 60 days. If someone uses the access key, then its expiration date increases by another 60 days. example: '2024-06-11T13:21:11.000Z' lastUsedAt: type: string description: The date and time at which the collection access key was used. If the collection key is unused, this returns an empty string value. example: '' createdAt: type: string format: date-time example: '2024-04-12T13:21:11.000Z' description: The date and time at which the collection access key was created. updatedAt: type: string format: date-time description: The date and time at which the collection access key was updated. example: '2024-04-12T13:21:11.000Z' deletedAt: type: string format: date-time nullable: true description: The date and time at which the collection access key was revoked. example: '2024-04-12T13:21:11.000Z' meta: type: object description: The response's non-standard metadata information. properties: nextCursor: type: string description: The pagination cursor that points to the next record in the results set. example: b2Zmc2V0PTEwJmxpbWl0PTEw prevCursor: type: string description: The pagination cursor to previous set of response data. example: '' commonErrorNameMessageDetails: title: Error (Name, Message, Details) type: object properties: error: type: object description: Information about the error. properties: name: type: string description: The error name. example: paramMissingError message: type: string description: The error message. example: Parameter is missing in the request. details: description: Information about the error. anyOf: - type: object title: object additionalProperties: true - type: array title: array items: type: string collectionAccessKeyId: type: string example: Njg5OjU3MDQ1NjYtYmQxZDU3NzktMWVkNS00ZDhjLWI0ZmQtZWRhOGY2Mzg1NTY0 asyncCollectionForkMerge: title: Merge/Pull Collection Changes type: object required: - strategy - source - destination properties: strategy: type: string description: | The fork's merge strategy: - `default` — Make no changes to the fork. You must have **Editor** access to the destination collection. - `updateSourceWithDestination` — Merge changes and apply any differences in the destination collection to the source. You must have **Editor** access to both the source and destination collection. - `deleteSource` — Merge the changes and delete the fork. You must have **Editor** access to both the source and destination collection. enum: - default - updateSourceWithDestination - deleteSource example: default source: type: string format: uid description: The source collection's unique ID. example: 12345678-5a027c05-056b-49f5-ac9d-37c29f2d91c3 destination: type: string format: uid description: The destination collection's unique ID. example: 12345678-b04fa319-3e7e-4fa3-b6a2-f5b29ad67583 asyncMergeCollectionFork: title: Successful Response type: object properties: task: type: object description: Information about the merge task. properties: id: type: string description: The task's ID. example: pm~vc:merge-workflow~12345678-4824989b-cd77-4e2f-856c-1ff2a3e9aaca status: type: string description: The task's status. example: in-progress collectionForkTaskId: type: string example: pm~vc:merge-workflow~12345678-5a027c05-056b-49f5-ac9d-37c29f2d91c3 asyncMergePullCollectionTaskStatus: title: Task Status Response type: object properties: id: type: string description: The task's ID. example: pm~vc:merge-workflow~12345678-5a027c05-056b-49f5-ac9d-37c29f2d91c3 status: type: string description: The task's current status. enum: - successful - in-progress - failed example: successful details: type: object description: If the task failed, an object containing information about the error. properties: error: type: object description: Information about the error. properties: message: type: string description: The error message. example: All conflicts have not be resolved collectionNameQuery: type: string example: Test Collection limitNoDefault: type: integer example: 3 offsetNoDefault: type: integer example: 0 collectionForkData: type: object description: If the collection is [forked](https://learning.postman.com/docs/collaborating-in-postman/version-control/#forking-postman-entities) from another collection, the fork's information. properties: label: type: string description: The fork's label. example: Collection fork createdAt: type: string format: date-time description: The date and time at which the collection was forked. example: '2024-07-17T13:12:43.000Z' from: type: string format: uid description: The source (parent) collection's unique ID. example: 87654321-c8142d52-f97d-46a7-bc77-52bb99713o1n metaLimitOffsetTotal: type: object description: The response's meta information for paginated results. properties: total: type: number description: The number of records found. example: 30 offset: type: number description: The zero-based offset of the first item returned. example: 0 limit: type: number description: The maximum number of records in the paginated response. example: 3 getCollections: title: Collections List type: object properties: collections: type: array description: A list of collections. items: type: object description: Information about the collection. properties: id: type: string description: The collection's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: type: string description: The collection's name. example: Test Collection owner: type: string description: The owner of the collection. example: '12345678' createdAt: type: string format: date-time description: The collection's creation date and time. example: '2022-01-13T10:21:46.000Z' updatedAt: type: string format: date-time description: The date and time at which the collection was last updated. example: '2022-01-13T10:21:46.000Z' uid: type: string format: uid description: The collection's unique ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 fork: $ref: '#/components/schemas/collectionForkData' isPublic: type: boolean description: If true, the collection is public and visible to all users. example: false meta: description: The response's meta information for paginated results. allOf: - $ref: '#/components/schemas/metaLimitOffsetTotal' info: title: Information type: object description: Information about the collection. required: - name - schema properties: name: type: string description: The collection's name. example: Test Collection description: type: string description: The collection's description. example: This is a test collection. schema: type: string description: The "https://schema.postman.com/json/collection/v2.1.0/collection.json" Postman Collection Format v2.1.0 schema. enum: - https://schema.postman.com/json/collection/v2.1.0/collection.json example: https://schema.postman.com/json/collection/v2.1.0/collection.json variable: title: Variable Info description: Information about the variable. type: object properties: key: type: string description: The variable's key (name). example: username value: anyOf: - type: string title: string - type: boolean title: boolean - type: integer title: integer description: The key's value. example: '123' description: type: string maxLength: 512 description: The variable's description. disabled: type: boolean default: false description: If true, the variable is not enabled. Doesn't apply to path parameter variables. variable-list: title: Collection Variables type: array description: A list of the collection's [variables](https://learning.postman.com/docs/sending-requests/variables/variables/). Make certain not to include sensitive information in variables. items: $ref: '#/components/schemas/variable' script: title: Script type: object description: Information about the Javascript code that can be used to to perform setup or teardown operations in a response. properties: type: type: string description: The type of script. For example, `text/javascript`. example: text/javascript exec: type: array description: A list of script strings, where each line represents a line of code. Separate lines makes it easy to track script changes. items: type: string nullable: true example: var data = JSON.parse(responseBody); event: title: Event type: object description: Information about the collection's events. required: - listen properties: listen: type: string description: Can be set to `test` or `prerequest` for test scripts or pre-request scripts respectively. enum: - test - prerequest example: test script: $ref: '#/components/schemas/script' event-list: title: Event List type: array description: A list of scripts configured to run when specific events occur. items: $ref: '#/components/schemas/event' url: title: URL description: Information about the URL. anyOf: - type: string format: url nullable: true description: The request's raw URL. example: https://88209df5-f1f9-4f29-82b2-9bb8bad11bdd.mock.pstmn.io - type: object properties: raw: type: string description: The request's raw URL. example: https://88209df5-f1f9-4f29-82b2-9bb8bad11bdd.mock.pstmn.io protocol: type: string description: The request protocol. example: https host: description: The host's URL. type: array items: type: string nullable: true example: postman-echo path: type: array description: A list of the URL's path components. items: type: string port: type: string description: The URL's port number. An empty value indicates port `80` (http) or `443` (https). example: '80' query: type: array description: A list of query parameters. These are the query string parts of the URL, parsed as separate variables. items: type: object properties: key: type: string nullable: true description: The query parameter's key. example: userId value: type: string nullable: true description: The key's value. example: '123' disabled: type: boolean default: false description: If true, the query parameter isn't sent with the request. example: true description: type: string nullable: true description: The query parameter's description. example: This is a custom query parameter. auth-attribute: title: Auth Attributes type: object required: - key description: Information about the supported Postman [authorization type](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/). properties: key: type: string description: The auth method's key value. example: algorithm value: anyOf: - type: string title: string - type: array title: array items: type: object description: The key's value. example: MD5 type: type: string description: The value's type. enum: - string - boolean - number - array - object - any example: string auth: type: object title: Auth Method description: The [authorization type supported by Postman](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/). required: - type properties: type: type: string description: The authorization type. enum: - noauth - basic - bearer - apikey - digest - oauth1 - oauth2 - hawk - awsv4 - ntlm - edgegrid example: digest noauth: {} apikey: type: array description: The API key's authentication information. items: $ref: '#/components/schemas/auth-attribute' awsv4: type: array description: The attributes for [AWS Signature](https://learning.postman.com/docs/sending-requests/authorization/aws-signature/) authentication. items: $ref: '#/components/schemas/auth-attribute' basic: type: array description: The attributes for [Basic Auth](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/#basic-auth). items: $ref: '#/components/schemas/auth-attribute' bearer: type: array description: The attributes for [Bearer Token](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/#bearer-token) authentication. items: $ref: '#/components/schemas/auth-attribute' digest: type: array description: The attributes for [Digest](https://learning.postman.com/docs/sending-requests/authorization/digest-auth/) access authentication. items: $ref: '#/components/schemas/auth-attribute' edgegrid: type: array description: The attributes for [Akamai Edgegrid](https://learning.postman.com/docs/sending-requests/authorization/akamai-edgegrid/) authentication. items: $ref: '#/components/schemas/auth-attribute' hawk: type: array description: The attributes for [Hawk](https://learning.postman.com/docs/sending-requests/authorization/hawk-authentication/) authentication. items: $ref: '#/components/schemas/auth-attribute' ntlm: type: array description: The attributes for [NTLM](https://learning.postman.com/docs/sending-requests/authorization/ntlm-authentication/) authentication. items: $ref: '#/components/schemas/auth-attribute' oauth1: type: array description: The attributes for [OAuth1](https://learning.postman.com/docs/sending-requests/authorization/oauth-10/) authentication. items: $ref: '#/components/schemas/auth-attribute' oauth2: type: array description: The attributes for [OAuth2](https://learning.postman.com/docs/sending-requests/authorization/oauth-20/) authentication. items: $ref: '#/components/schemas/auth-attribute' header: title: Header type: object description: Information about the header. required: - key - value properties: key: type: string description: The header's key, such as `Content-Type` or `X-Custom-Header`. example: Content-Type value: type: string description: The header key's value. example: application/json disabled: type: boolean default: false description: If true, the current header isn't sent with requests. example: false description: type: string description: The header's description. nullable: true example: This is a custom header. header-list: title: Header List description: A list of headers. type: array items: $ref: '#/components/schemas/header' request: title: Collection Request description: Information about the collection request. type: object properties: url: $ref: '#/components/schemas/url' auth: $ref: '#/components/schemas/auth' method: type: string description: The request's standard HTTP method. description: type: string description: The request's description. example: This is a test request. nullable: true header: $ref: '#/components/schemas/header-list' body: type: object description: Information about the collection's request body. To set this to "none", pass an empty object. properties: mode: description: The data associated with the request. enum: - raw - urlencoded - formdata - file - graphql example: formdata raw: type: string description: If the `mode` value is `raw`, the raw content of the request body. example: Test urlencoded: type: array description: A list of x-www-form-encoded key/value pairs. items: type: object required: - key properties: key: type: string description: The key value. example: userId value: type: string description: The key's value. example: '123' description: type: string description: The key's description. nullable: true example: This is a custom key. formdata: type: array description: If the `mode` value is `formdata`, then a list of form-data key/pair values. items: type: object required: - key anyOf: - properties: key: type: string description: The key value. example: userId value: type: string description: The key's value. example: '123' type: type: string description: The `text` value. enum: - text example: text contentType: type: string description: The form-data Content-Type header. example: application/json description: type: string description: The key's description. nullable: true example: This is a custom key. - properties: key: type: string description: The key value. example: file src: oneOf: - type: string nullable: true - type: array items: type: string type: type: string description: The `file` value. enum: - file example: file contentType: type: string description: The form-data Content-Type header. example: application/json description: type: string description: The key's description. nullable: true example: This is a custom file. file: type: object description: If the `mode` value is `file`, an object containing the file request information. properties: src: type: string nullable: true description: The name of the file to upload (not its path). A null value indicates that no file is selected as a part of the request body. example: postman-cloud:///2g041r86-4dfc-4e50-82b4-c756d83a5bec graphql: type: object description: If the `mode` value is `graphql`, an object containing the GraphQL request information. properties: query: type: string description: The GraphQL query. example: | mutation CreateTweet { createTweet(body: null) { id body date } markTweetRead(id: "123") } variables: type: string nullable: true description: The GraphQL query variables, in JSON format. example: |- { "id": "string" } options: type: object description: Additional configurations and options set for various modes. example: raw: language: json response: title: Response description: Information about the request's response. properties: originalRequest: $ref: '#/components/schemas/request' responseTime: description: The time taken by the request to complete. If a number, the unit is milliseconds. If the response is manually created, this can be set as null. type: number nullable: true header: anyOf: - type: string nullable: true - type: array description: A list of the request's headers. items: $ref: '#/components/schemas/header' body: type: string nullable: true description: The raw text of the response. example: |- { "field": {} } status: type: string description: The response's status. example: OK code: type: integer description: The response status code. example: 200 protocol-profile-behavior: title: Protocol Profile Behavior type: object description: The [settings](https://learning.postman.com/docs/sending-requests/create-requests/request-settings/) used to alter the [Protocol Profile Behavior](https://github.com/postmanlabs/postman-runtime/blob/develop/docs/protocol-profile-behavior.md) of sending a request. properties: strictSSL: type: boolean description: If true, enables certificate verification. followRedirects: type: boolean description: If true, follow HTTP 3xx responses as redirects. maxRedirects: type: number description: The maximum number of redirects to follow. disableBodyPruning: type: boolean description: If true, disables request body pruning for the GET, COPY, HEAD, PURGE, and UNLOCK methods. disableUrlEncoding: type: boolean description: If true, disables the percent encoding of auth, path, query, and fragment URL segments. disabledSystemHeaders: type: object description: Disable the system headers which are added implicitly. properties: cache-control: type: boolean postman-token: type: boolean content-type: type: boolean content-length: type: boolean accept-encoding: type: boolean connection: type: boolean host: type: boolean insecureHTTPParser: type: boolean description: If true, uses an insecure HTTP parser that accepts invalid HTTP headers. followOriginalHttpMethod: type: boolean description: If true, redirects with the original HTTP method. Redirects with the GET HTTP method by default. followAuthorizationHeader: type: boolean description: If true, retains the `authorization` header when a redirect happens to a different hostname. protocolVersion: type: string description: The HTTP protocol version to use. Supports the `http1`, `http2`, and `auto` values. enum: - http1 - http2 - auto removeRefererHeaderOnRedirect: type: boolean description: If true, removes the `referer` header when a redirect happens. tlsPreferServerCiphers: type: boolean description: If true, uses the server's cipher suite order instead of the client's during negotiation. tlsDisabledProtocols: type: array description: The SSL and TLS protocol versions to disable during negotiation. items: type: string tlsCipherSelection: type: array description: The order of cipher suites that the SSL server profile uses to establish a secure connection. items: type: string item: title: Item type: object description: Information about the collection request or folder. properties: name: type: string description: The item's name. example: Test Request description: type: string description: The item's description. example: This is a test request. nullable: true variable: $ref: '#/components/schemas/variable-list' event: $ref: '#/components/schemas/event-list' request: $ref: '#/components/schemas/request' response: type: array description: A list of the collection's responses. items: $ref: '#/components/schemas/response' protocolProfileBehavior: $ref: '#/components/schemas/protocol-profile-behavior' createCollectionSchema: type: object required: - info - item properties: info: $ref: '#/components/schemas/info' item: type: array items: $ref: '#/components/schemas/item' event: $ref: '#/components/schemas/event-list' variable: $ref: '#/components/schemas/variable-list' auth: $ref: '#/components/schemas/auth' protocolProfileBehavior: $ref: '#/components/schemas/protocol-profile-behavior' createCollection: title: Create Collection type: object properties: collection: description: Information about the collection. allOf: - $ref: '#/components/schemas/createCollectionSchema' collectionCreated: title: Collection Created type: object properties: collection: type: object description: Information about the created collection. properties: id: type: string description: The collection's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: type: string description: The collection's name. example: Test Collection uid: type: string format: uid description: The collection's unique ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 ascDesc: type: string enum: - asc - desc example: asc getCollectionsForkedByUser: title: User's Forked Collections type: object properties: data: type: array description: A list of the user's forked collections. items: type: object description: Information about the forked collection. properties: forkName: type: string description: The forked collection's label. example: Collection Fork forkId: type: string format: uid description: The forked collection's ID. example: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f sourceId: type: string description: The ID of the forked collection's source collection. example: 87654321-bd46b634-b347-44d4-aa23-8c71ff4ecc4d createdAt: type: string format: date-time description: The date and time at which the fork was created. example: '2023-11-16T09:18:17.000Z' meta: type: object description: The response's meta information for paginated results. properties: total: type: number description: The total number of forked collections. example: 2 nextCursor: type: string nullable: true format: base64 description: The pagination cursor that points to the next record in the results set. example: eyJpZCI6MzMyNzksImZvcmtzQWZ0ZXIiOjIwfQ== inaccessibleFork: type: number description: The total number of forked collections that the user cannot access. example: 0 fork400ErrorNoUserFound: title: Bad Request type: object properties: error: type: object description: Information about the error. properties: name: type: string description: The error name. example: badRequest message: type: string description: The error message. example: No Postman User found for given filters collectionId: type: string example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 createCollectionFork: title: Create Collection Fork type: object required: - label properties: label: type: string description: The fork's label. example: Test Fork createCollectionForkResponse: title: Collection Fork Created type: object properties: collection: type: object description: Information about the forked collection. properties: id: type: string description: The forked collection's ID. example: 09547fef-a9a5-4e00-998b-aa563e8db69a name: type: string description: The collection's name. example: Test Collection fork: $ref: '#/components/schemas/collectionForkData' uid: type: string format: uid description: The forked collection's unique ID. example: 12345678-09547fef-a9a5-4e00-998b-aa563e8db69a mergeCollectionFork: title: Merge Collection Fork type: object required: - source - destination properties: destination: type: string format: uid description: The destination (parent) collection's unique ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 source: type: string format: uid description: The source collection's unique ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 strategy: type: string description: | The fork's merge strategy: - `deleteSource` — Merge the changes into the parent collection. After the merge process is complete, Postman deletes the fork. You must have Editor access to both the parent and forked collections. - `updateSourceWithDestination` — Merge the changes into the parent collection. Any differences in the parent collection are also made to the fork. enum: - deleteSource - updateSourceWithDestination default: updateSourceWithDestination example: deleteSource mergeCollectionForkResponse: title: Collection Fork Merged type: object properties: collection: type: object description: Information about the merged collection. properties: id: type: string description: The source collection's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 uid: type: string format: uid description: The source collection's unique ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 collectionAccessKeyQuery: type: string example: PMAT-************************** collectionModelQuery: type: string enum: - minimal example: minimal variable-2: title: Variable Info description: Information about the variable. type: object properties: id: type: string description: The variable's ID. Doesn't apply to collection-level variables. example: 1561db76-bc21-48d1-a9f3-5d70c07b9d87 key: type: string description: The variable's key (name). example: userId description: type: string maxLength: 512 description: The variable's description. example: The user's ID. value: anyOf: - type: string title: string - type: boolean title: boolean - type: integer title: integer description: The key's value. example: '{{userId}}' enabled: type: boolean default: true description: If true, the variable is enabled. example: true disabled: type: boolean default: false description: If true, the variable is not enabled. Doesn't apply to path parameter variables. environmentSecret: type: boolean description: If true, the variable is marked as secret and its value is retrieved from the mentioned provider in the source field. example: false environmentVariableSource: type: object description: Information about the source of the variable's value. properties: postman: type: object description: Information about the Postman-specific source of the variable's value. properties: secretId: type: string description: The variable's secret ID. example: f5fa5280-18a3-4d93-a706-2fe48b1007dc type: type: string description: | The variable's type: - `cloud` — The variable value is synced and stored in the Postman Cloud. enum: - cloud example: cloud vaultId: type: string description: The variable's ID in the Postman Vault. example: 453a311c-c5b4-4627-8e51-a3bd48953734 provider: type: string description: The secret's provider. enum: - postman example: postman secretVariable: title: Secret Variable Info description: Information about the secret variable. type: object properties: enabled: type: boolean default: true description: If true, the variable is enabled. example: true key: type: string description: The variable's key (name). example: userId secret: $ref: '#/components/schemas/environmentSecret' source: $ref: '#/components/schemas/environmentVariableSource' id: type: string description: The variable's ID. Doesn't apply to collection-level variables. example: 1561db76-bc21-48d1-a9f3-5d70c07b9d87 description: type: string maxLength: 512 description: The variable's description. example: The user's ID. variable-list-2: title: Collection Variables type: array description: A list of the collection's [variables](https://learning.postman.com/docs/sending-requests/variables/variables/). Make certain not to include sensitive information in variables. items: anyOf: - $ref: '#/components/schemas/variable-2' - $ref: '#/components/schemas/secretVariable' script-2: title: Script type: object description: Information about the Javascript code that can be used to to perform setup or teardown operations in a response. properties: id: type: string description: The script's ID. example: 4981dd69-6138-45f6-990e-f122b267557f type: type: string description: The type of script. For example, `text/javascript`. example: text/javascript exec: type: array description: A list of script strings, where each line represents a line of code. Separate lines makes it easy to track script changes. items: type: string nullable: true example: var data = JSON.parse(responseBody); event-2: title: Event type: object description: Information about the collection's events. required: - listen properties: id: type: string description: The event's ID. example: 4981dd69-6138-45f6-990e-f122b267557f listen: type: string description: The `prerequest` (pre-request) or `test` (post-response) value. enum: - test - prerequest example: test script: $ref: '#/components/schemas/script-2' event-list-2: title: Event List type: array description: A list of scripts configured to run when specific events occur. These scripts can be referenced in the collection by their ID. items: $ref: '#/components/schemas/event-2' auth-2: type: object title: Auth Method description: The [authorization type supported by Postman](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/). required: - type properties: type: type: string description: The authorization type. enum: - basic - bearer - apikey - digest - oauth1 - oauth2 - hawk - awsv4 - ntlm - edgegrid - jwt - asap example: basic apikey: type: array description: The API key's authentication information. items: $ref: '#/components/schemas/auth-attribute' awsv4: type: array description: The attributes for [AWS Signature](https://learning.postman.com/docs/sending-requests/authorization/aws-signature/) authentication. items: $ref: '#/components/schemas/auth-attribute' basic: type: array description: The attributes for [Basic Auth](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/#basic-auth). items: $ref: '#/components/schemas/auth-attribute' bearer: type: array description: The attributes for [Bearer Token](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/#bearer-token) authentication. items: $ref: '#/components/schemas/auth-attribute' digest: type: array description: The attributes for [Digest](https://learning.postman.com/docs/sending-requests/authorization/digest-auth/) access authentication. items: $ref: '#/components/schemas/auth-attribute' edgegrid: type: array description: The attributes for [Akamai Edgegrid](https://learning.postman.com/docs/sending-requests/authorization/akamai-edgegrid/) authentication. items: $ref: '#/components/schemas/auth-attribute' hawk: type: array description: The attributes for [Hawk](https://learning.postman.com/docs/sending-requests/authorization/hawk-authentication/) authentication. items: $ref: '#/components/schemas/auth-attribute' ntlm: type: array description: The attributes for [NTLM](https://learning.postman.com/docs/sending-requests/authorization/ntlm-authentication/) authentication. items: $ref: '#/components/schemas/auth-attribute' oauth1: type: array description: The attributes for [OAuth1](https://learning.postman.com/docs/sending-requests/authorization/oauth-10/) authentication. items: $ref: '#/components/schemas/auth-attribute' oauth2: type: array description: The attributes for [OAuth2](https://learning.postman.com/docs/sending-requests/authorization/oauth-20/) authentication. items: $ref: '#/components/schemas/auth-attribute' jwt: type: array description: The attributes for JWT (JSON Web Token). Includes the `payload`, `secret`, `algorithm`, `addTokenTo`, and `headerPrefix` properties. items: $ref: '#/components/schemas/auth-attribute' asap: type: array description: The attributes for ASAP (Atlassian S2S Authentication Protocol). Includes the `kid`, `aud`, `iss`, `alg`, `privateKey`, and `claims` properties. items: $ref: '#/components/schemas/auth-attribute' header-2: title: Header type: object description: Information about the header. required: - key - value properties: key: type: string description: The header's key, such as `Content-Type` or `X-Custom-Header`. example: Content-Type value: type: string description: The header key's value. example: application/json description: type: string description: The header's description. example: The content type of the request body. nullable: true header-list-2: title: Header List description: A list of headers. type: array items: $ref: '#/components/schemas/header-2' request-2: title: Collection Request description: Information about the collection request. type: object properties: url: $ref: '#/components/schemas/url' auth: $ref: '#/components/schemas/auth-2' method: type: string description: The request's standard HTTP method. example: GET description: type: string description: The request's description. example: This is a test request. nullable: true header: $ref: '#/components/schemas/header-list-2' body: type: object description: Information about the collection's request body. properties: mode: description: The data associated with the request. enum: - raw - urlencoded - formdata - file - graphql example: formdata raw: type: string description: If the `mode` value is `raw`, the raw content of the request body. example: Test urlencoded: type: array description: A list of x-www-form-encoded key/value pairs. items: type: object required: - key properties: key: type: string description: The key value. example: userId value: type: string description: The key's value. example: '123' description: type: string description: The key's description. nullable: true example: This is a custom key. formdata: type: array description: If the `mode` value is `formdata`, then a list of form-data key/pair values. items: type: object required: - key anyOf: - properties: key: type: string description: The key value. example: userId value: type: string description: The key's value. example: '123' type: type: string description: The `text` value. enum: - text example: text contentType: type: string description: The form-data Content-Type header. example: application/json description: type: string description: The key's description. nullable: true example: This is a custom key. - properties: key: type: string description: The key value. example: file src: oneOf: - type: string nullable: true - type: array items: type: string type: type: string description: The `file` value. enum: - file example: file contentType: type: string description: The form-data Content-Type header. example: application/json description: type: string description: The key's description. nullable: true example: This is a custom file. file: type: object description: If the `mode` value is `file`, an object containing the file request information. properties: src: type: string nullable: true description: The name of the file to upload (not its path). A null value indicates that no file is selected as a part of the request body. example: postman-cloud:///2g041r86-4dfc-4e50-82b4-c756d83a5bec graphql: type: object description: If the `mode` value is `graphql`, an object containing the GraphQL request information. properties: query: type: string description: The GraphQL query. example: | mutation CreateTweet { createTweet(body: null) { id body date } markTweetRead(id: "123") } variables: type: string nullable: true description: The GraphQL query variables, in JSON format. example: |- { "id": "string" } options: type: object description: Additional configurations and options set for various modes. example: raw: language: json response-2: title: Response description: Information about the request's response. properties: id: type: string description: The response's ID. example: 33ffd2e3-59a8-4dfe-84fa-0a571984487b originalRequest: $ref: '#/components/schemas/request-2' responseTime: description: The time taken by the request to complete. The unit is milliseconds. type: number nullable: true header: anyOf: - type: string nullable: true - type: array description: A list of the request's headers. items: $ref: '#/components/schemas/header-2' body: type: string nullable: true description: The raw text of the response. status: type: string description: The response's status. example: OK code: type: integer description: The response status code. example: 200 createdAt: type: string format: date-time description: The date and time at which the response was created. example: '2023-08-22T12:52:01.000Z' updatedAt: type: string format: date-time description: The date and time at which the response was updated. example: '2023-09-13T14:31:25.000Z' uid: type: string format: uid description: The item's unique ID. example: 12345678-eb0c6a21-2625-4860-ace2-64d6ad91c551 item-2: title: Item type: object description: Information about the collection request or folder. required: - id properties: id: type: string description: The collection item's ID. example: 8d021b74-ecb5-460d-ac52-0d1e496d43d1 name: type: string description: The item's name. example: Test Request description: type: string description: The item's description. example: This is a test request. nullable: true variable: $ref: '#/components/schemas/variable-list-2' event: $ref: '#/components/schemas/event-list-2' request: $ref: '#/components/schemas/request-2' response: type: array description: A list of the collection's responses. items: $ref: '#/components/schemas/response-2' protocolProfileBehavior: $ref: '#/components/schemas/protocol-profile-behavior' createdAt: type: string format: date-time description: The date and time at which the collection item was created. example: '2023-08-22T12:52:01.000Z' updatedAt: type: string format: date-time description: The date and time at which the collection item was updated. example: '2023-09-13T14:31:25.000Z' uid: type: string format: uid description: The collection item's unique ID. example: 12345678-eb0c6a21-2625-4860-ace2-64d6ad91c551 collection-variable: title: Collection Variable Info description: Information about a collection-level variable. Collection variables don't support `id`, `description`, or `enabled` fields. Use `disabled` to control whether a variable is active. type: object properties: key: type: string description: The variable's key (name). example: userId value: anyOf: - type: string title: string - type: boolean title: boolean - type: integer title: integer description: The key's value. example: '{{userId}}' disabled: type: boolean default: false description: If true, the variable is not enabled. collection-secret-variable: title: Collection Secret Variable Info description: Information about a collection-level secret variable. Collection variables don't have an `id` field. type: object properties: enabled: type: boolean default: true description: If true, the variable is enabled. example: true key: type: string description: The variable's key (name). example: userId secret: $ref: '#/components/schemas/environmentSecret' source: $ref: '#/components/schemas/environmentVariableSource' description: type: string maxLength: 512 description: The variable's description. example: The user's ID. collection-variable-list: title: Collection Variables type: array description: A list of the collection's [variables](https://learning.postman.com/docs/sending-requests/variables/variables/). Make certain not to include sensitive information in variables. items: anyOf: - $ref: '#/components/schemas/collection-variable' - $ref: '#/components/schemas/collection-secret-variable' getCollection: title: Collection Information type: object properties: collection: type: object additionalProperties: true description: For a complete list of this endpoint's possible values, use the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). properties: info: type: object description: Information about the collection. properties: _postman_id: type: string description: The collection's Postman ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: type: string description: The collection's name. example: Test Collection description: type: string description: The collection's description. example: This is a sample collection that makes a tiny request to Postman Echo service to get the list of request headers sent by a HTTP client. schema: type: string format: url description: A URL to the collection's schema. example: https://schema.postman.com/json/collection/v2.1.0/collection.json fork: $ref: '#/components/schemas/collectionForkData' updatedAt: type: string format: date-time description: The date and time at which the collection was last updated. example: '2023-10-13T08:14:22.000Z' uid: type: string format: uid description: The collection's unique ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 createdAt: type: string format: date-time description: The date and time at which the collection was created. example: '2023-10-08T13:04:28.000Z' lastUpdatedBy: type: string description: The user ID of the user who last updated the collection. example: '12345678' item: type: array description: A list of the collection's requests and folders. items: $ref: '#/components/schemas/item-2' auth: description: The collection's authorization settings. allOf: - $ref: '#/components/schemas/auth-2' event: description: The collection's pre-request and test scripts. allOf: - $ref: '#/components/schemas/event-list-2' variable: description: The collection's variables. allOf: - $ref: '#/components/schemas/collection-variable-list' Prefer: type: string enum: - respond-async example: respond-async info-2: title: Information type: object description: Information about the collection. required: - name - schema properties: name: type: string description: The collection's name. example: Test Collection _postman_id: type: string description: The collection's Postman ID. This field exists for Postman Collection Format v1 compatibility. example: 64264c93-3a2c-49e3-8e3f-16568dd8fb83 description: type: string description: The collection's description. example: This is a test collection. schema: type: string description: The "https://schema.postman.com/json/collection/v2.1.0/collection.json" Postman Collection Format v2.1.0 schema. enum: - https://schema.postman.com/json/collection/v2.1.0/collection.json example: https://schema.postman.com/json/collection/v2.1.0/collection.json updatedAt: type: string format: date-time description: The date and time when the collection was last updated. example: '2025-05-28T08:56:07.000Z' createdAt: type: string format: date-time description: The date and time when the collection was created. example: '2025-05-28T08:56:07.000Z' lastUpdatedBy: type: string description: The user ID of the person who last updated the collection. example: '12345678' uid: type: string format: uid description: The collection's unique ID. example: 12345678-eb0c6a21-2625-4860-ace2-64d6ad91c551 modifyCollectionSchema: type: object required: - info - item properties: info: $ref: '#/components/schemas/info-2' item: type: array items: $ref: '#/components/schemas/item-2' event: $ref: '#/components/schemas/event-list-2' variable: $ref: '#/components/schemas/collection-variable-list' auth: $ref: '#/components/schemas/auth-2' protocolProfileBehavior: $ref: '#/components/schemas/protocol-profile-behavior' putCollection: title: Replace Collection Data type: object properties: collection: description: The new collection contents that replace the existing collection. allOf: - $ref: '#/components/schemas/modifyCollectionSchema' putCollectionResponse: title: Collection Updated type: object properties: collection: type: object description: Information about the updated collection. properties: id: type: string description: The collection's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: type: string description: The collection's name. example: Test Collection uid: type: string format: uid description: The collection's unique ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 putCollectionResponseAsync: title: Collection Updated Async type: object properties: task: type: object description: Information about the async update task. properties: id: type: string description: The collection update task's ID. Use this value to get the update's status with the GET `/collection-updates-tasks/{taskId}` endpoint. example: be15d43c-0ca9-427b-b073-1c4228f32f8d status: type: string description: The task's current status. example: in-progress deleteCollection: title: Collection Deleted type: object properties: collection: type: object description: Information about the deleted collection. properties: id: type: string description: The deleted collection's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 uid: type: string format: uid description: The deleted collection's unique ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 collection-script: title: Script type: object description: Information about the Javascript code that runs on a collection-level event. Unlike request-level scripts, collection-level scripts require a client-supplied `id` value. required: - id properties: id: type: string description: The script's ID. You must supply a value (for example, a UUID) when creating or updating collection-level events. example: 4981dd69-6138-45f6-990e-f122b267557f type: type: string description: The type of script. For example, `text/javascript`. example: text/javascript exec: type: array description: A list of script strings, where each line represents a line of code. Separate lines makes it easy to track script changes. items: type: string nullable: true example: var data = JSON.parse(responseBody); collection-event: title: Event type: object description: Information about a collection-level event. Collection events don't accept a top-level `id`; the event is identified by its `script.id` value, which the client must supply. required: - listen properties: listen: type: string description: The `prerequest` (pre-request) or `test` (post-response) value. enum: - test - prerequest example: test script: $ref: '#/components/schemas/collection-script' collection-event-list: title: Event List type: array description: A list of scripts configured to run when specific events occur on the collection. Each event's `script.id` value must be supplied by the client. items: $ref: '#/components/schemas/collection-event' patchCollection: title: Update Collection type: object properties: collection: type: object description: | The collection updates to apply. You must pass at least one of the following: `info`, `variable`, `auth`, or `events`. Unsupported properties are rejected. additionalProperties: false anyOf: - required: - info - required: - variable - required: - auth - required: - events properties: info: type: object description: An object that contains the collection's updated name and description. additionalProperties: false properties: name: type: string description: The collection's updated name. example: Test Collection v2 description: type: string description: The collection's updated description. example: This collection makes a request to the Postman Echo service to get a list of request headers sent by an HTTP client. variable: type: array description: A list of the collection's variables to add or update. Secret variables can't be set through this endpoint; manage cloud or vault-backed secrets through environments instead. items: $ref: '#/components/schemas/collection-variable' auth: description: The collection's updated authorization settings. allOf: - $ref: '#/components/schemas/auth-2' events: description: The collection's updated pre-request and test scripts. allOf: - $ref: '#/components/schemas/collection-event-list' patchCollectionResponse: title: Collection Updated type: object properties: collection: type: object description: Information about the updated collection. properties: id: type: string description: The collection's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: type: string description: The collection's updated name. example: Test Collection v2 description: type: string description: The collection's updated description. example: This is a sample collection that makes a request to the Postman Echo service. It returns a list of request headers sent by an HTTP client. duplicateCollection: type: object required: - workspace properties: workspace: type: string description: The workspace ID in which to duplicate the collection. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 suffix: type: string description: An optional suffix to append to the duplicated collection's name. example: Copy duplicateCollectionResponse: type: object properties: task: type: object description: Information about the duplication task. properties: id: type: string description: The duplication task's ID. example: 12345678-d2584d81-3283-42d5-9d84-b897257adcf0 status: type: string description: The status of the collection duplication task. enum: - processing - completed - failed example: processing reason: type: string nullable: true description: If the task failed, the reason why it failed to complete. example: instance not found createCollectionFolder: title: Create Folder type: object additionalProperties: true description: | Information about the collection folder. For a complete list of properties, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json). **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. properties: name: type: string example: Test Folder description: The folder's name. 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. folder: type: string format: uid description: The ID of a folder in which to create the folder. example: 12345678-65a99e60-8e0a-4b6e-b79c-7d8264cc5caa createCollectionFolderResponse: title: Collection Folder Created type: object properties: data: type: object description: Information about the collection folder. For a complete list of properties, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). additionalProperties: true properties: id: type: string description: The folder's ID. example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa name: type: string description: The folder's name. example: Test Folder order: type: array description: A list of request IDs and their order in the created folder. items: type: string uniqueItems: true example: [] owner: type: string description: The user ID of the folder's owner. example: '12345678' folder: type: string nullable: true description: Information about the folder. example: null folders: type: array description: A list of folders. items: type: string example: [] requests: type: array description: A list of requests. items: type: string createdAt: type: string format: date-time description: The folder's creation date and time. example: '2022-08-29T16:49:19.964Z' updatedAt: type: string format: date-time description: The date and time at which the folder was last updated. example: '2022-08-29T16:49:19.964Z' collection: type: string description: The collection ID that the folder belongs to. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 description: type: string description: The folder's description. example: This is a test collection folder. folders_order: type: array items: type: string uniqueItems: true description: A list of folder IDs and their order in the collection. example: [] lastUpdatedBy: type: string description: The user ID of the user that last updated the folder. example: '12345678' meta: type: object description: A Postman-specific response that contains information about the internal performed operation. additionalProperties: true model_id: type: string description: The folder's ID. example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa revision: type: number description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource. example: 24994132707 collectionFolderUid: type: string format: uid example: 12345678-65a99e60-8e0a-4b6e-b79c-7d8264cc5caa getCollectionForks: title: Collection Forks Info type: object properties: data: type: array description: A list of the collection's forks. items: type: object description: Information about the forked collection. properties: createdAt: type: string format: date-time description: The date and time at which the fork was created. example: '2023-11-16T09:18:17.000Z' createdBy: type: string description: The user who created the collection fork. example: Taylor Lee forkId: type: string format: uid description: The forked collection's ID. example: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f forkName: type: string description: The forked collection's label. example: Collection Fork meta: type: object description: The response's meta information for paginated results. properties: nextCursor: type: string nullable: true format: base64 description: The pagination cursor that points to the next record in the results set. example: eyJpZCI6MzMyNzksImZvcmtzQWZ0ZXIiOjIwfQ== total: type: number description: The total number of forked collections. example: 2 fork404Error: title: Not Found type: object properties: error: type: object description: Information about the error. properties: name: type: string description: The error name. example: notFoundError message: type: string description: The error message. example: Fork not found. elementTypeSpec: type: string enum: - spec example: spec generatedSpecCollectionData: title: Collection Spec Information type: object description: Information about the collection's API specification. properties: id: type: string description: The collection's ID. example: b4fc1bdc-6587-4f9b-95c9-f768146089b4 name: type: string description: The collection's name. example: Sample API state: type: string description: The sync state of the collection and its API specification. enum: - in-sync - out-of-sync - sync-in-progress example: in-sync createdAt: type: string format: date-time description: The date and time at which the collection was generated. example: '2025-03-15T13:48:28.000Z' updatedAt: type: string format: date-time description: The date and time at which the collection was updated. example: '2025-03-15T13:48:28.000Z' createdBy: type: integer description: The user ID of the user that generated the collection. example: 12345678 updatedBy: type: integer description: The ID of the user who updated the collection. example: 12345678 metaData: title: Meta Information type: object description: The response's meta information for paginated results. properties: nextCursor: type: string nullable: true format: base64 description: The pagination cursor that points to the next record in the results set. example: VGh1IE1hciAxNiAyMDIzIDE3OjIxOjUzIEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk= getGeneratedCollectionSpecs: type: object properties: specs: type: array description: A list of the collection's generated API specficiations. items: $ref: '#/components/schemas/generatedSpecCollectionData' meta: description: The response's meta information for paginated results. allOf: - $ref: '#/components/schemas/metaData' generateSpecFromCollection: type: object required: - name properties: name: type: string description: The API specification's name. example: Sample API type: type: string description: The specification's type. enum: - OPENAPI:2.0 - OPENAPI:3.0 - OPENAPI:3.1 example: OPENAPI:3.0 format: type: string description: The format of the API specification. enum: - JSON - YAML example: JSON generateTaskResponse: title: Task Created type: object properties: taskId: type: string description: The created task ID. You can use this ID to track the status of the task. example: 66ae9950-0869-4e65-96b0-1e0e47e771af url: type: string description: The URL to get or poll the status of a generated spec task. example: /specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/tasks/66ae9950-0869-4e65-96b0-1e0e47e771af documentationColorSettings: type: object description: The theme's colors, in six digit hexcode. The values in this object must match the hexcode values of either the `light` or `dark` theme defined in the `appearance` object. properties: highlight: type: string description: The hexcode color code for the documentation's highlighting. example: EF5B25 rightSidebar: type: string description: The hexcode color code for the documentation's right sidebar color. example: '303030' topBar: type: string description: The hexcode color code for the documentation's top bar color. example: FFFFFF documentationMetaTags: type: object required: - name - value properties: name: type: string description: | The key's name: - `title` — The title of your documentation. This value appears in relevant search queries and browser tabs. By default, the system uses the collection's name for the documentation title. - `description` — The documentation's description. This provides brief information about your document and lets users know what it contains. By default, the system uses the collection's description content. example: title value: type: string description: The `name` key's value. example: Billing API documentationThemeSettings: type: object properties: name: type: string description: The `light` or `dark` theme. enum: - dark - light example: dark colors: $ref: '#/components/schemas/documentationColorSettings' logo: type: string nullable: true description: The URL to the documentation's logo image. By default, public documentation uses your team logo. example: / documentationApperanceSettings: type: object description: Information about the documentation appearance, such as colors and theme. properties: default: type: string description: The default color theme (`light` or `dark`). Documentation uses the given theme value by default. enum: - light - dark example: dark themes: type: array description: A list of theme settings for the `light` and `dark` themes. items: $ref: '#/components/schemas/documentationThemeSettings' documentationCustomizationSettings: type: object description: Information about the documentation's customization. properties: metaTags: type: array description: The key-pair values that contain the documentation's `title` and `description` metadata information. items: $ref: '#/components/schemas/documentationMetaTags' appearance: $ref: '#/components/schemas/documentationApperanceSettings' publishDocumentation: type: object required: - customColor - customization properties: environmentUid: type: string format: uid description: The unique ID of the environment to publish with the documentation. The initial values of all variables are published with the documentation. Make certain they don't contain sensitive information such as passwords or tokens. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 customColor: $ref: '#/components/schemas/documentationColorSettings' documentationLayout: type: string default: classic-single-column description: | The documentation's default layout style: - `classic-single-column` — Displays sample code inline beneath each request. - `classic-double-column` — Displays sample code in a column next to the documentation. enum: - classic-single-column - classic-double-column example: classic-single-column customization: $ref: '#/components/schemas/documentationCustomizationSettings' publishDocumentationResponse: type: object properties: published: type: boolean description: If true, the documentation is published. example: true documentationLayout: type: string description: The documentation's default layout style. example: classic-double-column customization: $ref: '#/components/schemas/documentationCustomizationSettings' publishDate: type: string format: date-time description: The date and time at which the documentation was published. example: '2025-03-08T07:44:30.000Z' publisherId: type: string description: The user ID of the user that published the documentation. example: '12345678' environmentUid: type: string format: uid description: The unique ID of the environment published with the collection documentation. example: 12345678-df582ac2-898e-4be4-a29f-56b9ade1daab customColor: $ref: '#/components/schemas/documentationColorSettings' publicUrl: type: string format: url description: The public URL of the published documentation. example: https://documenter.postman.com/view/12345678/6n1Xaix id: type: string description: The published documentation's ID. example: 6n1Xaix collectionId: type: string description: The collection's ID. example: f9921930-cb79-4dda-8a9a-5d2b3004289d pullCollectionChangesResponse: title: Collection Changes Pulled type: object properties: collection: type: object description: Information about the updated collection fork. properties: destinationId: type: string format: uid description: The ID of the forked collection the changes were pulled into. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 sourceId: type: string format: uid description: The ID of the source collection the changes were pulled from. example: 12345678-45499451-e894-41b8-8c66-8191ab64932a getCollectionPullRequests: title: Collection Pull Requests type: object properties: data: type: array description: A list of the collection's pull requests. items: type: object description: Information about the pull request. properties: createdAt: type: string description: The date and time at which the pull request was created. example: '2024-02-20T09:55:46.000Z' createdBy: type: string description: The ID of the user who created the pull request. example: '12345678' description: type: string description: The pull request's description. example: This is an open pull request. destinationId: type: string description: The pull request's merge destination ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 href: type: string description: A URL where you can view the pull request's details. example: /pull-requests/4e1a6609-1a29-4037-a411-89ecc14c6cd8 id: type: string description: The pull request's ID. example: 4e1a6609-1a29-4037-a411-89ecc14c6cd8 sourceId: type: string description: The pull request's source (parent) ID. example: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef status: type: string description: The pull request's current status. enum: - open - approved - declined - merged example: open comment: type: string description: If the pull request is declined, a comment about why the pull request was declined. example: Missing information. title: type: string description: The pull request's title. example: Open PR updatedBy: type: string description: The ID of the user who updated the pull request. example: '12345678' updatedAt: type: string format: date-time description: The date and time at which the pull request was updated. example: '2024-02-20T09:58:38.000Z' pullRequestCreate: title: Create Pull Request type: object required: - title - reviewers - destinationId description: Information about the pull request. properties: title: type: string description: The title of the pull request. example: Test PR description: type: string description: The pull request's description. example: This is a test pull request. reviewers: type: array description: A list of reviewers to assign to the pull request. items: type: string description: The reviewer's user ID. example: '87654321' destinationId: type: string description: The collection ID to merge the pull request into. example: 12345678-ec548788-unftw-rgn8-83b8-0b59798648e4 pullRequestCreated: title: Pull Request Created type: object properties: createdAt: type: string description: The date and time at which the pull request was created. example: '2024-02-20T09:55:46.000Z' createdBy: type: string description: The ID of the user who created the pull request. example: '12345678' description: type: string description: The pull request's description. example: This is a test pull request. destinationId: type: string description: The pull request's merge destination ID. example: 12345678-ec548788-unftw-rgn8-83b8-0b59798648e4 id: type: string description: The pull request's ID. example: 4e1a6609-1a29-4037-a411-89ecc14c6cd8 sourceId: type: string description: The pull request's source (parent) ID. example: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef status: type: string description: The pull request's current status. example: open title: type: string description: The pull request's title. example: Test PR updatedAt: type: string description: The date and time at which the pull request was updated. example: '2024-02-20T09:58:57.000Z' collectionFolderId: type: string example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa request-method: type: string description: The request's HTTP method. enum: - GET - PUT - POST - PATCH - DELETE - COPY - HEAD - OPTIONS - LINK - UNLINK - PURGE - LOCK - UNLOCK - PROPFIND - VIEW example: GET request-header-data: type: array description: The request's headers. items: type: object properties: key: type: string description: The header's key. value: type: string description: The header's value. description: type: string description: The header's description. request-query-params: type: array description: The request's query parameters. items: type: object properties: key: type: string description: The query parameter's key. value: type: string description: The query parameter's value. description: type: string description: The query parameter's description. enabled: type: boolean description: If true, the query parameter is enabled. request-data: type: array nullable: true description: The request body's form data. items: type: object properties: key: type: string description: The form data's key. value: type: string description: The form data's value. description: type: string description: The form data's description. enabled: type: boolean description: If true, the form data entry is enabled. type: type: string description: The form data's type. enum: - text - file uuid: type: string description: The form data entry's unique identifier. request-graphql-mode-data: type: object nullable: true description: The request body's GraphQL mode data. properties: query: type: string description: The GraphQL query. variables: type: string description: The GraphQL query variables, in JSON format. request-data-options: type: object nullable: true description: Additional configurations and options set for the request body's various data modes. properties: raw: type: object description: Options for the `raw` data mode. properties: language: type: string description: The raw mode data's language type. urlencoded: type: object description: Options for the `urlencoded` data mode. params: type: object description: Options for the `params` data mode. binary: type: object description: Options for the `binary` data mode. graphql: type: object description: Options for the `graphql` data mode. request-auth: type: object nullable: true description: The request's authentication information. required: - type properties: type: type: string description: The authorization type. enum: - basic - bearer - apikey - digest - oauth1 - oauth2 - hawk - awsv4 - ntlm - edgegrid - jwt - asap - noauth apikey: type: array description: The API key's authentication information. items: $ref: '#/components/schemas/auth-attribute' awsv4: type: array description: The attributes for AWS Signature authentication. items: $ref: '#/components/schemas/auth-attribute' basic: type: array description: The attributes for Basic Auth. items: $ref: '#/components/schemas/auth-attribute' bearer: type: array description: The attributes for Bearer Token authentication. items: $ref: '#/components/schemas/auth-attribute' digest: type: array description: The attributes for Digest access authentication. items: $ref: '#/components/schemas/auth-attribute' edgegrid: type: array description: The attributes for Akamai Edgegrid authentication. items: $ref: '#/components/schemas/auth-attribute' hawk: type: array description: The attributes for Hawk authentication. items: $ref: '#/components/schemas/auth-attribute' ntlm: type: array description: The attributes for NTLM authentication. items: $ref: '#/components/schemas/auth-attribute' oauth1: type: array description: The attributes for OAuth1 authentication. items: $ref: '#/components/schemas/auth-attribute' oauth2: type: array description: The attributes for OAuth2 authentication. items: $ref: '#/components/schemas/auth-attribute' jwt: type: array description: The attributes for JWT authentication. items: $ref: '#/components/schemas/auth-attribute' asap: type: array description: The attributes for ASAP authentication. items: $ref: '#/components/schemas/auth-attribute' request-events: type: array nullable: true description: A list of scripts configured to run when specific events occur. items: type: object properties: listen: type: string description: The event type. enum: - test - prerequest script: $ref: '#/components/schemas/script-2' createCollectionRequest: title: Create Request type: object additionalProperties: true description: | Information about the request. For a complete list of properties, refer to the **Request** property in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json). **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. properties: name: type: string example: Test Request description: The request's name. 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. description: type: string nullable: true description: The request's description. method: description: The request's HTTP method. allOf: - $ref: '#/components/schemas/request-method' url: type: string nullable: true description: The request's URL. headerData: description: The request's headers. allOf: - $ref: '#/components/schemas/request-header-data' queryParams: description: The request's query parameters. allOf: - $ref: '#/components/schemas/request-query-params' dataMode: type: string description: The request body's data mode. enum: - raw - urlencoded - formdata - binary - graphql data: description: The request body's form or urlencoded data. allOf: - $ref: '#/components/schemas/request-data' rawModeData: type: string nullable: true description: The request body's raw mode data. graphqlModeData: description: The request body's GraphQL mode data. allOf: - $ref: '#/components/schemas/request-graphql-mode-data' dataOptions: description: Additional options for the request body data. allOf: - $ref: '#/components/schemas/request-data-options' auth: description: The request's authorization settings. allOf: - $ref: '#/components/schemas/request-auth' events: description: The request's pre-request and test scripts. allOf: - $ref: '#/components/schemas/request-events' createCollectionRequestResponse: title: Collection Request Created type: object properties: data: type: object additionalProperties: true description: Information about the created request. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). properties: id: type: string description: The request's ID. example: c82dd02c-4870-4907-8fcb-593a876cf05b name: type: string description: The request's name. example: Test Request owner: type: string description: The user ID of the request's owner. example: '12345678' folder: type: string nullable: true description: Information about the request's parent folder. example: null responses: type: array description: A list of the request's responses. items: type: string example: [] collection: type: string description: The collection ID that the request belongs to. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 responses_order: type: array description: A list of response IDs and their order in the folder. items: type: string uniqueItems: true example: [] createdAt: type: string format: date-time description: The requeset's creation date and time. example: '2022-08-29T16:35:38.831Z' updatedAt: type: string format: date-time description: The date and time at which the request was last updated. example: '2022-08-29T16:35:38.831Z' lastUpdatedBy: type: string description: The user ID of the user that last updated the folder. example: '12345678' meta: type: object description: A Postman-specific response that contains information about the internal performed operation. additionalProperties: true model_id: type: string description: The request's ID. example: c82dd02c-4870-4907-8fcb-593a876cf05b revision: type: number description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource. example: 26531992398 collectionRequestUid: type: string format: uid example: 12345678-c82dd02c-4870-4907-8fcb-593a876cf05b collectionRequestId: type: string example: c82dd02c-4870-4907-8fcb-593a876cf05b createCollectionResponse: title: Collection Response Created type: object additionalProperties: true description: | Information about the response. For a complete list of properties, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **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. properties: name: type: string example: Example POST Response description: The response's name. 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. description: type: string nullable: true description: The response's description. url: type: string nullable: true description: The associated request's URL. method: description: The associated request's HTTP method. allOf: - $ref: '#/components/schemas/request-method' headers: description: The response's headers. allOf: - $ref: '#/components/schemas/header-list-2' dataMode: type: string description: The associated request body's data mode. enum: - raw - urlencoded - formdata - binary - graphql rawModeData: type: string nullable: true description: The associated request body's raw mode data. dataOptions: description: Additional options for the associated request body data. allOf: - $ref: '#/components/schemas/request-data-options' responseCode: type: object description: The response's HTTP response code information. properties: code: type: number description: The response's HTTP response status code. example: 200 name: type: string description: The name of the status code. example: OK status: type: string nullable: true description: The response's HTTP status text. time: type: string description: The time taken by the request to complete, in milliseconds. cookies: type: string nullable: true description: The response's cookie data. mime: type: string nullable: true description: The response's MIME type. text: type: string description: The raw text of the response body. language: type: string description: The response body's language type. rawDataType: type: string nullable: true description: The response's raw data type. requestObject: type: string description: A JSON-stringified representation of the associated request. createCollectionResponseResponse: title: Collection Response Created type: object properties: data: type: object additionalProperties: true description: Information about the response. For a complete list of properties, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). properties: id: type: string description: The response's ID. example: 43e1277f-6079-4feb-9316-c8ec24605092 owner: type: string description: The user ID of the response's owner. example: '12345678' request: type: string description: The request ID of the response's associated request. example: c82dd02c-4870-4907-8fcb-593a876cf05b createdAt: type: string format: date-time description: The date and time at which the response was created. example: '2022-08-19T15:06:18.940Z' updatedAt: type: string format: date-time description: The date and time at which the response was last updated. example: '2022-08-19T15:06:18.940Z' lastUpdatedBy: type: string description: The user ID of the user who last updated the response. example: '12345678' meta: type: object description: A Postman-specific response that contains information about the internal performed operation. additionalProperties: true model_id: type: string description: The response's ID. example: 43e1277f-6079-4feb-9316-c8ec24605092 revision: type: number description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource. example: 26532286083 collectionResponseUid: type: string format: uid example: 12345678-cc364734-7dfd-4bfc-897d-be763dcdbb07 getCollectionRoles: title: Collection Roles Info type: object description: Information about the collection's roles. properties: group: type: array description: A list of the collection's group roles. items: type: object description: Information about the group role. properties: role: type: string description: | The role type: - `VIEWER` — Can view, fork, and export collections. - `EDITOR` — Can edit collections directly. enum: - VIEWER - EDITOR example: VIEWER id: type: number description: The role's ID. example: 123 team: type: array description: A list of the collection's team roles. items: type: object description: Information about the team role. properties: role: type: string description: | The role type: - `VIEWER` — Can view, fork, and export collections. - `EDITOR` — Can edit collections directly. enum: - VIEWER - EDITOR example: EDITOR id: type: number description: The role's ID. example: 1 user: type: array description: A list of the collection's user roles. items: type: object description: Information about the user role. properties: role: type: string description: | The role type: - `VIEWER` — Can view, fork, and export collections. - `EDITOR` — Can edit collections directly. enum: - VIEWER - EDITOR example: VIEWER id: type: number description: The role's ID. example: 12345678 commonErrorTypeTitle: title: Error (Title, Type) type: object properties: title: type: string description: A short summary of the problem. example: Invalid request type: type: string description: The type of error. example: badRequest updateCollectionRoles: title: Update Collection Roles type: object required: - roles properties: roles: type: array description: A list of role update operations to apply to the collection. items: type: object required: - op - path - value properties: op: type: string description: The operation to perform on the path. enum: - update example: update path: type: string description: The resource to perform the action on. enum: - /user - /group - /team example: /user value: type: array description: A list of the roles to assign to the resource. items: type: object description: Information about the updated role. required: - id - role properties: id: type: number description: The user, group, or team's ID. example: 12345678 role: type: string description: |- The role type: - `VIEWER` — Can view, fork, and export collections. - `EDITOR` — Can edit collections directly. enum: - VIEWER - EDITOR example: VIEWER getSourceCollectionStatus: title: Source Collection Status type: object properties: collection: type: object description: Information about the source collection. properties: collectionUid: type: object description: Information about the forked collection. The object's name is the forked collection's UID (`userId`-`collectionId`). properties: isSourceAhead: type: boolean description: If true, there is a difference between the forked collection and its source collection. example: false forkCollection400Error: title: Bad Request type: object properties: collection: type: object description: Information about the collection that failed to fork. properties: name: type: string description: The error name. example: badRequest message: type: string description: The error message. example: The collection is not a forked collection. booleanQuery: type: boolean example: true getCollectionFolder: title: Collection Folder Info type: object properties: model_id: type: string description: The folder's ID. example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa meta: type: object description: A Postman-specific response that contains information about the internal performed operation. additionalProperties: true data: type: object description: Information about the folder. For a complete list of properties, refer to the **Folders** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). additionalProperties: true properties: id: type: string description: The folder's ID. example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa name: type: string description: The folder's name. example: Test Folder description: type: string description: The folder's description. example: This is a test collection folder. createdAt: type: string format: date-time description: The folder's creation date and time. example: '2022-08-29T16:49:19.964Z' updatedAt: type: string format: date-time description: The date and time at which the folder was last updated. example: '2022-08-29T16:49:19.964Z' owner: type: string description: The user ID of the folder's owner. example: '12345678' lastUpdatedBy: type: string description: The user ID of the user that last updated the folder. example: '12345678' lastRevision: type: integer format: int64 description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource. example: 24994132707 collection: type: string description: The collection ID that the folder belongs to. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 updateCollectionFolder: title: Update Folder type: object additionalProperties: true description: The folder properties to update. For a complete list of properties, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json). properties: name: type: string description: The folder's name. example: Test Folder description: type: string description: The folder's description. example: This is a test folder. updateCollectionFolderResponse: title: Collection Folder Updated type: object properties: data: type: object additionalProperties: true description: The folder's updated information, including the updated properties. For a complete list of properties, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json). properties: id: type: string description: The folder's ID. example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa name: type: string description: The folder's name. example: Test Folder description: type: string description: The folder's description. example: This is a test collection folder. createdAt: type: string format: date-time description: The folder's creation date and time. example: '2022-08-29T16:49:19.964Z' updatedAt: type: string format: date-time description: The date and time at which the folder was last updated. example: '2022-08-29T16:49:19.964Z' owner: type: string description: The user ID of the folder's owner. example: '12345678' lastUpdatedBy: type: string description: The user ID of the user that last updated the folder. example: '12345678' lastRevision: type: integer format: int64 description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource. example: 24977100955 collection: type: string description: The collection ID that the folder belongs to. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 folder: type: string nullable: true description: Information about the folder. example: null meta: type: object description: A Postman-specific response that contains information about the internal performed operation. additionalProperties: true model_id: type: string description: The folder's ID. example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa revision: type: number description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource. example: 24994132707 deleteCollectionFolder: title: Collection Folder Deleted type: object properties: data: type: object description: The folder's information. properties: id: type: string description: The folder's ID. example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa owner: type: string description: The user ID of the folder's owner. example: '12345678' meta: type: object description: A Postman-specific response that contains information about the internal performed operation. additionalProperties: true model_id: type: string description: The folder's ID. example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa revision: type: number description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource. example: 24994562696 getCollectionRequest: title: Collection Request Info type: object properties: model_id: type: string description: The request's ID. example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa meta: type: object description: A Postman-specific response that contains information about the internal performed operation. additionalProperties: true data: type: object additionalProperties: true description: Information about the request. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). properties: id: type: string description: The request's ID. example: c82dd02c-4870-4907-8fcb-593a876cf05b name: type: string description: The request's name. example: Test Folder owner: type: string description: The user ID of the request's owner. example: '12345678' lastRevision: type: integer format: int64 description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource. example: 24994132707 lastUpdatedBy: type: string description: The user ID of the user that last updated the request. example: '12345678' createdAt: type: string format: date-time description: The request's creation date and time. example: '2022-08-29T16:49:19.964Z' updatedAt: type: string format: date-time description: The date and time at which the request was last updated. example: '2022-08-29T16:49:19.964Z' updateCollectionRequest: title: Update Request type: object additionalProperties: true description: The request properties to update. For a complete list of properties, refer to the **Request** property in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json). properties: name: type: string description: The request's name. example: Example GET request description: type: string nullable: true description: The request's description. method: description: The request's HTTP method. allOf: - $ref: '#/components/schemas/request-method' url: type: string nullable: true description: The request's URL. headerData: description: The request's headers. allOf: - $ref: '#/components/schemas/request-header-data' queryParams: description: The request's query parameters. allOf: - $ref: '#/components/schemas/request-query-params' dataMode: type: string description: The request body's data mode. enum: - raw - urlencoded - formdata - binary - graphql data: description: The request body's form or urlencoded data. allOf: - $ref: '#/components/schemas/request-data' rawModeData: type: string nullable: true description: The request body's raw mode data. graphqlModeData: description: The request body's GraphQL mode data. allOf: - $ref: '#/components/schemas/request-graphql-mode-data' dataOptions: description: Additional options for the request body data. allOf: - $ref: '#/components/schemas/request-data-options' auth: description: The request's authorization settings. allOf: - $ref: '#/components/schemas/request-auth' events: description: The request's pre-request and test scripts. allOf: - $ref: '#/components/schemas/request-events' updateCollectionRequestResponse: title: Collection Request Updated type: object properties: data: type: object additionalProperties: true description: Information about the updated request. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). properties: id: type: string description: The request's ID. example: c82dd02c-4870-4907-8fcb-593a876cf05b name: type: string description: The request's name. example: Example GET request description: type: string description: The request's description. example: This is an example GET request. createdAt: type: string format: date-time description: The request's creation date and time. example: '2022-08-29T16:49:19.964Z' updatedAt: type: string format: date-time description: The date and time at which the request was last updated. example: '2022-08-29T16:49:19.964Z' owner: type: string description: The user ID of the request's owner. example: '12345678' lastUpdatedBy: type: string description: The user ID of the user that last updated the request. example: '12345678' lastRevision: type: integer format: int64 example: 24994863800 description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource. meta: type: object description: A Postman-specific response that contains information about the internal performed operation. additionalProperties: true model_id: type: string description: The request's ID. example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa revision: type: number description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource. example: 24994954828 deleteCollectionRequest: title: Collection Request Deleted type: object properties: model_id: type: string description: The request's ID. example: c82dd02c-4870-4907-8fcb-593a876cf05b meta: type: object description: A Postman-specific response that contains information about the internal performed operation. additionalProperties: true data: type: object description: The request's information. properties: id: type: string description: The request's ID. example: c82dd02c-4870-4907-8fcb-593a876cf05b owner: type: string description: The user ID of the request's owner. example: '12345678' revision: type: number description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource. example: 24995158577 collectionResponseId: type: string example: cc364734-7dfd-4bfc-897d-be763dcdbb07 getCollectionResponse: title: Collection Response Info type: object properties: data: type: object description: Information about the response. For a complete list of properties, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). additionalProperties: true properties: id: type: string description: The response's ID. example: cc364734-7dfd-4bfc-897d-be763dcdbb07 request: type: string description: The ID of the request that the response belongs to. example: c82dd02c-4870-4907-8fcb-593a876cf05b name: type: string description: The response's name. example: Test Folder owner: type: string description: The user ID of the response's owner. example: '12345678' createdAt: type: string format: date-time description: The response's creation date and time. example: '2022-08-29T16:49:19.964Z' updatedAt: type: string format: date-time description: The date and time at which the response was last updated. example: '2022-08-29T16:49:19.964Z' lastRevision: type: integer format: int64 description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource. example: 24994132707 lastUpdatedBy: type: string description: The user ID of the user that last updated the response. example: '12345678' meta: type: object description: A Postman-specific response that contains information about the internal performed operation. additionalProperties: true model_id: type: string description: The response's ID. example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa updateCollectionResponse: title: Update Collection Response type: object additionalProperties: true description: The response properties to update. For a complete list of properties, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json). properties: name: type: string description: The response's name. example: Bad Request description: type: string nullable: true description: The response's description. url: type: string nullable: true description: The associated request's URL. method: description: The associated request's HTTP method. allOf: - $ref: '#/components/schemas/request-method' headers: description: The response's headers. allOf: - $ref: '#/components/schemas/header-list-2' dataMode: type: string description: The associated request body's data mode. enum: - raw - urlencoded - formdata - binary - graphql rawModeData: type: string nullable: true description: The associated request body's raw mode data. dataOptions: description: Additional options for the associated request body data. allOf: - $ref: '#/components/schemas/request-data-options' responseCode: type: object description: The response's HTTP response code information. properties: code: type: number description: The response's HTTP response status code. example: 400 name: type: string description: The name of the status code. example: Bad Request status: type: string nullable: true description: The response's HTTP status text. time: type: string description: The time taken by the request to complete, in milliseconds. cookies: type: string nullable: true description: The response's cookie data. mime: type: string nullable: true description: The response's MIME type. text: type: string description: The raw text of the response body. language: type: string description: The response body's language type. rawDataType: type: string nullable: true description: The response's raw data type. requestObject: type: string description: A JSON-stringified representation of the associated request. updateCollectionResponseResponse: title: Collection Response Updated type: object properties: data: type: object description: Information about the updated response. For a complete list of response properties, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). additionalProperties: true properties: id: type: string description: The response's ID. example: c82dd02c-4870-4907-8fcb-593a876cf05b name: type: string description: The response's name. example: Test Folder owner: type: string description: The user ID of the response's owner. example: '12345678' createdAt: type: string format: date-time description: The response's creation date and time. example: '2022-08-29T16:49:19.964Z' updatedAt: type: string format: date-time description: The date and time at which the response was last updated. example: '2022-08-29T16:49:19.964Z' lastRevision: type: integer format: int64 description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource. example: 24994132707 lastUpdatedBy: type: string description: The user ID of the user that last updated the response. example: '12345678' meta: type: object description: A Postman-specific response that contains information about the internal performed operation. additionalProperties: true model_id: type: string description: The response's ID. example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa deleteCollectionResponse: title: Collection Response Deleted type: object properties: model_id: type: string description: The response's ID. example: cc364734-7dfd-4bfc-897d-be763dcdbb07 meta: type: object description: A Postman-specific response that contains information about the internal performed operation. additionalProperties: true data: type: object description: The response's information. properties: id: type: string description: The response's ID. example: cc364734-7dfd-4bfc-897d-be763dcdbb07 owner: type: string description: The user ID of the request's owner. example: '12345678' revision: type: number description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource. example: 24997417224 tagElement400Error: title: Bad Request type: object properties: error: type: string description: A short summary of the problem. example: Bad Request message: type: string description: The error message. example: params/slug must match pattern \"^[a-z][a-z0-9-]*[a-z0-9]+$\" statusCode: type: integer format: http-status-code description: The error's HTTP status code. example: 400 collectionTransformFormat: type: string default: json enum: - json - yaml example: json transformCollectionToOpenAPI: title: Collection Transformed type: object properties: output: type: string description: The collection's transformed output, in a stringified OpenAPI JSON or YAML format. example: |- { "openapi": "3.0.3", "info": { "title": "Sample API", "description": "Buy or rent spacecrafts\n\nContact Support:\n Name: Jon", "version": "1.0.0", "contact": {} }, "servers": [ { "url": "example.com" } ], "paths": { "/spacecrafts/{spacecraftId}": { "get": { "tags": [ "spacecrafts", "{spacecraftId}" ], "summary": "Read a spacecraft", "description": "Read a spacecraft", "operationId": "readASpacecraft", "responses": { "200": { "description": "The spacecraft corresponding to the provided `spacecraftId`", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "example": "" }, "id": { "type": "string", "example": "" }, "name": { "type": "string", "example": "" }, "type": { "type": "string", "example": "satellite" } } }, "examples": { "The spacecraft corresponding to the provided `spacecraftId`": { "value": { "description": "", "id": "", "name": "", "type": "satellite" } } } } } }, "404": { "description": "No spacecraft found for the provided `spacecraftId`", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "" } } }, "examples": { "No spacecraft found for the provided `spacecraftId`": { "value": { "message": "" } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "" } } }, "examples": { "Unexpected error": { "value": { "message": "" } } } } } } } }, "parameters": [ { "name": "spacecraftId", "in": "path", "required": true, "schema": { "type": "string", "example": "" }, "description": "(Required) The unique identifier of the spacecraft" } ] } }, "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "name": "X-Api-Key", "in": "header" } } }, "security": [ { "apiKey": [] } ], "tags": [ { "name": "spacecrafts" }, { "name": "{spacecraftId}" } ] } transferCollectionItems: title: Transfer Collection Items type: object required: - ids - target - location - mode properties: ids: type: array description: A list of collection request, response, or folder UIDs to transfer. items: type: string format: uid example: 12345678-a9b481c1-3e78-4af7-8db0-dce3f3f3c105 mode: type: string description: The transfer operation to perform. enum: - copy - move example: move target: type: object description: Information about the item transfer's destination location. required: - model - id properties: id: type: string format: uid example: 12345678-b91270fa-048d-4f5f-a033-8b5523bf053f description: The UID of the destination collection, folder, or request. model: type: string description: The collection, folder, or request that the items will be transferred to. For response transfers, use the `request` value. enum: - collection - folder - request example: request location: type: object description: | The transferred items' placement in the target destination: - For `start` or `end` — Do not include the `model` and `id` values. - For `before` or `after` — Include the `model` and `id` properties. required: - position properties: id: type: string nullable: true format: uid description: For `before` or `after` positions, the model's UID. example: 12345678-80812b16-ac27-45b3-b3eb-793f78530d32 model: type: string nullable: true description: | For `before` or `after` positions, the type of item (model) that the transferred item will be positioned by. One of: `folder`, `request`, or `response.` example: response position: type: string default: end description: The transferred item's position within the destination object. enum: - start - end - before - after example: before transferCollectionItemsResponse: title: Collection Items Transferred type: object properties: ids: type: array description: A list of the transferred collection request, response, or folder UIDs. items: type: string format: uid example: 12345678-a9b481c1-3e78-4af7-8db0-dce3f3f3c105 taskUid: type: string format: uid example: 12345678-66ae9950-0869-4e65-96b0-1e0e47e771af taskId: type: string example: 66ae9950-0869-4e65-96b0-1e0e47e771af getCollectionUpdatesTasks: title: Get Collection Update Status type: object properties: id: type: string description: The task's ID. example: 66ae9950-0869-4e65-96b0-1e0e47e771af status: type: string description: The task's current status. enum: - successful - failed - in-progress example: successful threadId: type: integer example: 34567 componentType: type: string description: The component's type. Corresponds to the specification that the component's content adheres to. enum: - OAS2 - OAS3 - OAS3_1 example: OAS3 componentStatus: description: | The component's lifecycle state: - `active` — The component is active and can be edited and published. - `archive` — The component is archived and read-only. Archived components can't be edited or published, but their existing versions remain accessible. type: string enum: - active - archive example: active componentHasVersions: type: boolean enum: - true - false example: true componentIncludeFields: type: string example: hasVersions,latestVersion componentExpandLatestVersion: type: string example: latestVersion meta: type: object description: The response's meta information for paginated results. properties: nextCursor: type: string nullable: true description: The pagination cursor that points to the next record in the results set. example: bmV4dDppZDpZWEpqYUdsMllXeEVRaXhtWldWa2MxOHlNREkxWHpFc01UTXpNelE0 componentVersionId: type: string description: The component version's ID. example: 01KT9NBTW5GYETHG6V0HNPAPYV componentVersionData: title: Component Version Data type: object description: Information about a component's version. properties: id: $ref: '#/components/schemas/componentVersionId' label: type: string description: The component version's label. example: 1.0.0 url: type: string format: uri description: The URL where the component version can be accessed. example: https://components.postman.com/example/Test1/1.0.0 format: type: string description: The component version's content format. example: YAML publishedAt: type: string format: date-time description: The date and time at which the component version was published. example: '2026-01-15T10:30:00.000Z' content: type: string description: The version's content. This returns when you include the `include` parameter. example: |- openapi: 3.0.0 info: title: Example API version: 1.0.0 componentData: title: Component Data type: object description: Information about the component. properties: id: type: string description: The component's ID. example: 01KT964C30J3DPJQKEACZH39N8 name: type: string description: The component's name. example: example-component type: $ref: '#/components/schemas/componentType' status: $ref: '#/components/schemas/componentStatus' createdAt: type: string format: date-time description: The date and time at which the component was created. example: '2026-01-15T10:30:00.000Z' updatedAt: type: string format: date-time description: The date and time at which the component was last updated. example: '2026-01-15T10:30:00.000Z' createdBy: type: string description: The ID of the user who created the component. example: '12345678' updatedBy: type: string description: The ID of the user who last updated the component. example: '12345678' hasVersions: type: boolean description: Whether the component has versions. Returns only when you pass the `hasVersions` value for the `include` parameter. example: true latestVersion: description: | Information about the component's latest version. This property only returns only when you pass the `latestVersion` value for the `include` parameter. To return detailed information about the component's latest version, pass the `latestVersion` value for the `expand` parameter. oneOf: - title: Component Version ID type: string nullable: true description: The component version's ID. example: 01KT9NBTW5GYETHG6V0HNPAPYV - $ref: '#/components/schemas/componentVersionData' getAllComponents: type: object properties: meta: $ref: '#/components/schemas/meta' data: type: array description: A list of components. items: $ref: '#/components/schemas/componentData' componentContentFormatData: title: Component Content Format type: string description: The component's content format. enum: - JSON - YAML example: YAML createComponent: type: object required: - name - type - content properties: name: type: string minLength: 1 maxLength: 60 pattern: ^[a-zA-Z0-9\-_.]+$ description: The component's name. This must be unique within the team and can only contain letters, digits, hyphens, underscores, and periods and can't exceed 60 characters. example: example-component type: $ref: '#/components/schemas/componentType' content: type: string description: The component's content, up to a maximum of 500 KB (UTF-8). example: |- openapi: 3.0.0 info: title: Example API version: 1.0.0 format: description: The component's content format. Defaults to YAML. default: YAML allOf: - $ref: '#/components/schemas/componentContentFormatData' example: YAML componentId: type: string description: The component's ID. example: 01KT964C30J3DPJQKEACZH39N8 createComponentResponse: type: object description: Information about the component. properties: id: $ref: '#/components/schemas/componentId' getComponent: type: object properties: data: $ref: '#/components/schemas/componentData' updateComponent: type: object oneOf: - title: Rename Component required: - name - title: Update Status required: - status properties: name: type: string description: The component's name. The new name must be unique within the team. example: update-component-name status: $ref: '#/components/schemas/componentStatus' updateComponentResponse: type: object description: Information about the component. properties: id: $ref: '#/components/schemas/componentId' name: type: string description: The component's name. example: update-component-name status: $ref: '#/components/schemas/componentStatus' getComponentDraft: type: object properties: content: type: string description: The component's draft content. example: |- openapi: 3.0.0 info: title: Example API version: 1.0.0 format: type: string description: The component draft's content format. example: YAML updateComponentDraft: type: object minProperties: 1 description: Information about the component draft. properties: content: type: string description: The component's contents, up to a maximum of 500 KB (UTF-8). example: |- openapi: 3.0.0 info: title: Example API version: 1.0.0 format: $ref: '#/components/schemas/componentContentFormatData' updateComponentDraftResponse: type: object description: Information about the component draft. properties: id: type: string description: The component draft's ID. example: 01KT964C30J3DPJQKEACZH39N8 componentLibraryInclude: type: string example: content getComponentVersions: type: object properties: meta: $ref: '#/components/schemas/meta' data: type: array description: A list of the component's versions. items: $ref: '#/components/schemas/componentVersionData' createComponentVersion: type: object required: - label properties: label: type: string minLength: 1 maxLength: 60 pattern: ^[a-zA-Z0-9]([a-zA-Z0-9._+-]{0,58}[a-zA-Z0-9])?$ description: The component version's label. This must begin and end with an alphanumeric character and may only contain letters, digits, dots, underscores, plus signs, and hyphens and cannot exceed 60 characters. example: 1.0.0 source: type: object additionalProperties: false description: The source to publish the version from. Defaults to the component's current draft. properties: type: type: string description: The `draft` value. enum: - draft example: draft createComponentVersionResponse: type: object description: Information about the component version. properties: id: $ref: '#/components/schemas/componentVersionId' submitContextGraphAsk: title: Submit Context Graph Ask type: object required: - query properties: query: type: string minLength: 1 maxLength: 2000 description: The natural-language question to answer against the graph. example: What endpoints does authentication-service expose? includeAnswer: type: boolean default: true description: Whether to include the prose answer in the result. If `false`, the result's `answer` property is `null` and the result's other properties are unaffected. example: true maxSteps: type: integer minimum: 1 maximum: 15 default: 10 description: The maximum number of tool calls the ask can make. Must be between `1` and `15`. example: 8 contextGraphAskStatus: type: string description: The ask's lifecycle state. enum: - pending - running - completed - failed example: completed submitContextGraphAskResponse: title: Submit Context Graph Ask Response type: object required: - askId - status properties: askId: type: string description: The created ask's ID. Use this value to poll the ask. example: 01a03dd2-0d99-766e-b3df-e36dcaaee706 status: $ref: '#/components/schemas/contextGraphAskStatus' contextGraphAskId: type: string description: The ask's ID. example: 01a03dd2-114a-766f-820b-4209e4fc78d2 contextGraphProvenanceStep: title: Provenance Step type: object description: A single read-only tool call the ask made while answering the question. required: - tool properties: tool: type: string description: The name of the read-only tool that was called. example: run_cypher type: type: string description: The preset query type the tool was called with. This property is only present if the tool was called with one. example: api-detail rowCount: type: integer description: The number of rows the tool returned. example: 31 error: type: string description: The error message for this step. This property is only present if the step failed. example: query timed out getContextGraphAskResponse: title: Get Context Graph Ask Response type: object required: - askId - status - question - revision - createdAt properties: askId: type: string description: The ask's ID. example: 01a03dd2-114a-766f-820b-4209e4fc78d2 status: $ref: '#/components/schemas/contextGraphAskStatus' question: type: string description: The natural-language question that was asked. example: What endpoints does authentication-service expose? revision: type: integer nullable: true description: The graph revision the ask was evaluated against. example: 1 createdAt: type: string format: date-time description: The date and time the ask was submitted, in ISO 8601 format. example: '2026-08-26T11:26:12.000Z' completedAt: type: string format: date-time nullable: true description: The date and time the ask reached a terminal state, in ISO 8601 format. This value is `null` until the ask is `completed` or `failed`. example: '2026-08-26T11:26:28.000Z' error: type: string nullable: true description: A short reason the ask failed, such as the ask having timed out. This property is only present if `status` is `failed`. example: reaped_stale result: type: object description: The ask's result. This property is only present if `status` is `completed`. required: - citations - provenance - usage properties: answer: type: string nullable: true description: The natural-language answer to the question. This value is `null` if `includeAnswer` was `false` in the request. example: The authentication-service exposes 31 endpoints across health checks, public auth, handover, certificates, and internal auth-scheme management. structured: type: object additionalProperties: true description: The graph data the answer rests on. The shape of this object varies with the question. example: entities: - type: api name: authentication-service provenance: type: object description: Information about how the ask reached its answer. required: - revision - steps properties: revision: type: integer description: The graph revision the ask ran against. example: 1 truncated: type: boolean description: Whether the ask reached its deadline and returned a partial result. example: false steps: type: array description: The ordered tool calls the ask made to reach its answer. items: $ref: '#/components/schemas/contextGraphProvenanceStep' example: - tool: run_cypher rowCount: 31 citations: type: array description: The graph entities the answer is grounded in. The shape of each item varies with the entity's kind. items: type: object additionalProperties: true description: A cited graph entity. example: - api_name: authentication-service - path: /api/auth/logout usage: type: object description: A summary of the resources the ask consumed. required: - steps properties: steps: type: integer description: The number of tool calls the ask made. example: 2 outputTokens: type: integer description: The number of LLM output tokens the ask consumed. This property is only present if the value is known. example: 707 limitDefault10Max100: type: integer default: 10 minimum: 1 maximum: 100 example: 10 customFunctionSummary: type: object description: Information about the custom function, without its content. properties: id: type: string description: The custom function's ID. example: 01JCUSTOMFN0123456789ABCDE name: type: string description: The custom function's name, derived from its path. example: checkResourceNesting path: type: string description: The custom function's path, in the form `functions/.js`. example: functions/checkResourceNesting.js description: type: string description: The custom function's description. example: Custom Spectral function. type: type: string description: The custom function's type. enum: - system - custom example: custom createdBy: type: string description: The ID of the user who created the custom function. example: '12345678' updatedBy: type: string description: The ID of the user who last updated the custom function. example: '12345678' createdAt: type: string format: date-time description: The date and time at which the custom function was created. example: '2026-07-13T10:15:30.000Z' updatedAt: type: string format: date-time description: The date and time at which the custom function was last updated. example: '2026-07-13T11:20:00.000Z' customFunctionList: type: object description: A paginated list of custom function summaries. properties: data: type: array description: A list of custom functions. items: $ref: '#/components/schemas/customFunctionSummary' meta: $ref: '#/components/schemas/meta' customFunctionCreate: type: object description: Information about the custom function. required: - path - content properties: path: type: string maxLength: 512 pattern: ^functions/[a-zA-Z_$][a-zA-Z0-9_$]+\.js$ description: The custom function's path, in the form `functions/.js`. Root-level paths and nested paths are not supported. The name must be at least two characters, start with a letter, underscore, or dollar sign, and contain only letters, numbers, underscores, and dollar signs. example: functions/checkResourceNesting.js description: type: string maxLength: 255 description: The custom function's description. example: Custom Spectral function. content: type: string description: The custom function's content, up to a maximum of 500 KB (UTF-8). example: export default (input) => { return []; }; writeResult: type: object description: Information about the updated or created resource. required: - id properties: id: type: string description: The resource's ID. example: 01JABCDEF0123456789ABCDEFG customFunctionId: type: string example: 01JCUSTOMFN0123456789ABCDE apiGovernanceInclude: type: string enum: - content example: content customFunction: description: Information about the custom function. The `content` field is only present when the request includes the `include=content` query parameter on the get-by-ID endpoint. allOf: - $ref: '#/components/schemas/customFunctionSummary' - type: object properties: content: type: string description: The custom function's content, up to a maximum of 500 KB (UTF-8). example: export default (input) => { return []; }; customFunctionUpdate: type: object minProperties: 1 additionalProperties: false description: Information about the custom function. properties: path: type: string maxLength: 512 pattern: ^functions/[a-zA-Z_$][a-zA-Z0-9_$]+\.js$ description: The custom function's path, in the form `functions/.js`. Root-level paths and nested paths aren't supported. example: functions/checkResourceNestingV2.js description: type: string maxLength: 255 description: The custom function's description. example: Updated custom Spectral function. content: type: string description: The custom function's content, up to a maximum of 500 KB (UTF-8). example: export default (input) => { return []; }; include: type: string example: meta.total sinceDateTime: type: string format: date-time example: '2022-06-01T00:00:00.000Z' untilDateTime: type: string format: date-time example: '2022-06-15T00:00:00.000Z' secretResolutionStatus: type: string description: | The secret's resolution status: - `ACTIVE` — The secret is active. - `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. enum: - FALSE_POSITIVE - ACCEPTED_RISK - REVOKED - ACTIVE example: FALSE_POSITIVE detectedSecretsResourcesData: type: object properties: type: type: string description: The type of resource. enum: - collection - environment - extensible-collection - globals - example - request - folder - extensible-collection-meta - extensible-request - extensible-folder - extensible-example - extensible-message example: collection ids: type: array description: A list of resource IDs. items: type: string description: The resource's ID. example: 12345678-94720289-b9f3-4572-b34d-ecdfb9225b07 workspaceVisibilitiesData: type: string description: The type of visibility setting. enum: - team - public example: team detectedSecretsQueriesRequest: title: Detected Secrets Query Request type: object properties: resolved: type: boolean description: If true, return secrets with a `resolved` status. example: true secretTypes: type: array description: A list of secrets types to query. For a list of valid IDs, use the GET `/secret-types` endpoint. items: type: string description: The secret type ID. example: 1a7ec5d1-dcba-4ec7-8220-3c1ee490416b statuses: type: array description: A list of the types of resolution statuses to query. items: $ref: '#/components/schemas/secretResolutionStatus' resources: type: array description: A list of resources to query. If you use this query, you cannot also pass the `workspaceIds` query. items: $ref: '#/components/schemas/detectedSecretsResourcesData' workspaceIds: type: array description: A list of workspaces IDs to query. If you use this query, you cannot also pass the `resources` query. items: type: string description: The workspace ID. example: 0fe6c2f2-022d-48f7-8e7e-3244369445b0 workspaceVisibilities: type: array description: A list of workspace [visibility settings](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility) to query. This currently supports the `team` and `public` settings. items: $ref: '#/components/schemas/workspaceVisibilitiesData' metaLimitNextCursorTotalIncludeParam: type: object description: The response's meta information for paginated results. properties: limit: type: number description: The maximum number of records in the paginated response. example: 2 nextCursor: type: string nullable: true format: base64 description: The pagination cursor that points to the next record in the results set. example: MTA4 total: type: number description: The number of records that match the defined criteria. This is only returned when the `include` query parameter is passed with the `meta.total` value. example: 20 detectedSecretsData: type: object properties: detectedAt: type: string format: date-time example: '2023-05-19T02:45:31.000Z' description: The date and time at which the secret was first detected. secretType: type: string description: The type of the secret. example: Airtable API Key workspaceVisibility: type: string description: The workspace's [visibility setting](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility). enum: - personal - private - team - public example: team secretHash: type: string description: The SHA-256 hash of the detected secret. example: 07afd1f787f3555d441b04870dbe1025db8309fbeb31f25b3a20f2f1241478b3 workspaceId: type: string description: The ID of the workspace that contains the secret. example: e361eeb4-00dd-4225-9774-6146a2555999 resourceType: type: string description: If querying by resource, the resource type. example: example resourceId: type: string description: If querying by resource, the resource's ID. example: 12345678-400005df-3cad-480c-a027-ea68aed35b60 secretId: type: string description: The detected secret's ID. example: OTI3OTYx obfuscatedSecret: type: string description: The secret's obfuscated value. example: keyTF2WAH****** resolution: $ref: '#/components/schemas/secretResolutionStatus' occurrences: type: number description: The number of times the secret was found in the workspace. example: 3 detectedSecretsQueries: title: Search Detected Secrets Request type: object properties: meta: $ref: '#/components/schemas/metaLimitNextCursorTotalIncludeParam' data: type: array description: A list of detected secrets that match the search criteria. items: $ref: '#/components/schemas/detectedSecretsData' commonErrorTypeTitleStatusInstance: title: Error (Type, Title, Status, Instance) type: object properties: type: type: string description: The type of error. example: Bad Request title: type: string description: A short summary of the problem. example: limit specified is invalid status: type: integer format: http-status-code description: The HTTP status code generated by the origin server. example: 400 instance: type: string description: The URI reference that identifies the specific occurrence of the problem. example: '' secretId: type: string example: MTc0ODA0Mw== updateSecretResolutionsRequest: title: Update Secret Resolution Request required: - resolution - workspaceId type: object properties: resolution: $ref: '#/components/schemas/secretResolutionStatus' workspaceId: type: string description: The ID of the workspace that contains the secret. example: e361eeb4-00dd-4225-9774-6146a2555999 secretResolutionsHistoryData: type: object properties: actor: type: number description: The ID of the user that updated the secret's resolution status. example: 12345678 createdAt: type: string format: date-time description: The date and time at which the resolution status was updated. example: '2024-09-18T18:46:26.000Z' resolution: $ref: '#/components/schemas/secretResolutionStatus' updateSecretResolutions: title: Successful Response type: object properties: secretHash: type: string description: The SHA-256 hash of the detected secret. example: 50dbd2... workspaceId: type: string description: The ID of the workspace that contains the secret. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 resolution: $ref: '#/components/schemas/secretResolutionStatus' history: type: array description: The history of the secret's resolution status changes. items: $ref: '#/components/schemas/secretResolutionsHistoryData' resourceType: type: string enum: - collection - environment - extensible-collection - globals - example - request - folder - extensible-collection-meta - extensible-request - extensible-folder - extensible-example - extensible-message example: collection secretsLocationsData: type: object description: Information about the secret finding locations. properties: isResourceDeleted: type: boolean description: If true, the resource in which the secret was found was deleted. example: false leakedBy: type: integer description: The ID of the user who exposed the secret. example: 12345678 location: type: string description: The location where the secret was found. example: Headers occurrences: type: integer description: The number of times the secret occurs in the location. example: 1 parentResourceId: type: string format: uid description: The parent resource's unique ID. If the resource is a request, folder, or example, this value is a collection ID. If the resource is a collection, globals, or environment, this is the resource's ID. example: 12345678-14728df4-c7af-424f-b665-5047b7d25866 resourceId: type: string format: uid description: The unique ID of the resource where the secret was detected. example: 12345678-e0df25e0-d245-40dd-89b5-68720d186d3f resourceType: type: string description: The type of resource in which the secret was detected. example: example detectedAt: type: string format: date-time description: The date and time at which the secret was detected. example: '2023-04-25T08:13:48.000Z' url: type: string description: The URL to the resource that contains the secret. example: https://go.postman.co/build/workspace/80ab14ae-c17d-4fd6-88d5-99bf13f0b7f0/example/12345678-e0df25e0-d245-40dd-89b5-68720d186d3f secretActivityFeedData: type: object properties: resolvedAt: type: string format: date-time description: The date and time at which the resolution status was last updated. example: '2023-04-25T11:18:07.000Z' resolvedBy: type: integer description: The ID of the user that updated the secret's resolution status. example: 12345678 status: $ref: '#/components/schemas/secretResolutionStatus' secretScannerMetaData: type: object description: The response's meta information for paginated results. properties: activityFeed: type: array description: The history of the secret's resolution status changes. items: $ref: '#/components/schemas/secretActivityFeedData' cursor: type: string description: The pointer to the first record of the set of paginated results. example: MTIyNjY5Nw== limit: type: integer description: The maximum number of rows to return in the response. example: 2 nextCursor: type: string nullable: true description: The Base64-encoded value that points to the next record in the results set. example: null obfuscatedSecret: type: string description: The secret's obfuscated value. example: PMAK-644781584627df042afa6655-******ba secretHash: type: string description: The secret's SHA-256 hash. example: 0096b35ef6621d7571f106fefee5b10e8ed360cc9bf04f343f267ca4ff65bb5d secretType: type: string description: The type of thesecret. example: Postman API Key total: type: integer description: The total number of discovered secret locations. example: 3 getSecretsLocations: title: Successful Response type: object properties: data: type: array description: A list of the locations where the detected secret was found. items: $ref: '#/components/schemas/secretsLocationsData' meta: description: The response's meta information for paginated results. allOf: - $ref: '#/components/schemas/secretScannerMetaData' elementType: type: string enum: - collections - specs example: collections elementId: anyOf: - type: string title: Spec ID - type: string format: uid title: Collection UID example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 asyncSpecTaskStatus: type: object title: Task Resources description: Information about the task's resources. properties: resources: type: array description: A list of the resources the task produced. items: type: object properties: id: type: string description: The ID of the assigned resource. example: 12345678-e726de58-f1b3-4edd-a8a7-2579dc799d39 url: type: string description: The task's assigned resource URL. example: /collections/e726de58-f1b3-4edd-a8a7-2579dc799d39 getAsyncTaskStatus: title: Get Async Task Status type: object properties: meta: type: object description: The response's non-standard meta information. properties: action: type: string description: The task's action. example: generation model: type: string description: The model for which the task is performing the operation. enum: - collection - spec example: collection details: $ref: '#/components/schemas/asyncSpecTaskStatus' status: type: string description: The task's current status. enum: - pending - failed - completed example: completed getAsyncTaskStatusFailed: title: Async Task Failed type: object properties: details: type: string description: Details about the generation error. example: Failed to generate collection from specification meta: type: object description: The response's non-standard meta information. properties: action: type: string description: The task's action. example: generation model: type: string description: The model for which the task is performing the operation. enum: - collection - spec example: collection status: type: string description: The task's current status. enum: - failed example: failed getEnvironmentsInfo: type: object description: Information about the environment. properties: id: type: string description: The environment's ID. example: 5daabc50-8451-43f6-922d-96b403b4f28e name: type: string description: The environment's name. example: Test Environment createdAt: type: string format: date-time description: The date and time at which the environment was created. example: '2020-09-23T14:31:18.000Z' updatedAt: type: string format: date-time description: The date and time at which the environment was last updated. example: '2020-12-04T14:13:40.000Z' owner: type: string description: The environment owner's ID. example: '12345678' uid: type: string format: uid description: The environment's unique ID. example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e isPublic: type: boolean description: If true, the environment is public and visible to all users. example: false getEnvironments: title: Successful Response type: object properties: environments: type: array description: A list of environments. items: $ref: '#/components/schemas/getEnvironmentsInfo' environmentVariables: title: Add Variable type: object description: Information about the variable. properties: enabled: type: boolean description: If true, the variable is enabled. example: true key: type: string description: The variable's name. example: collectionId value: type: string description: The variable's value. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 type: type: string description: | The variable's type: - `secret` — The variable value is masked. - `default` — The variable value is visible in plain text. enum: - secret - default example: default description: type: string maxLength: 512 description: The variable's description. example: The collection's ID. environmentVaultVariables: type: object title: Add Secret Variable description: Information about the variable stored in the Postman Vault. This property only returns when a variable is defined as secret. properties: enabled: type: boolean description: If true, the variable is enabled. example: true key: type: string description: The variable's name. example: collectionId value: type: string description: The variable's value. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 type: type: string description: | The variable's type: - `secret` — The variable value is masked. - `default` — The variable value is visible in plain text. enum: - secret - default example: default secret: $ref: '#/components/schemas/environmentSecret' source: $ref: '#/components/schemas/environmentVariableSource' description: type: string maxLength: 512 description: The variable's description. example: The collection's ID. createEnvironment: title: Create Environment type: object properties: environment: type: object description: Information about the environment. required: - name properties: name: type: string description: The environment's name. example: Test Environment values: type: array description: Information about the environment's variables. items: anyOf: - $ref: '#/components/schemas/environmentVariables' - $ref: '#/components/schemas/environmentVaultVariables' createEnvironmentResponse: title: Environment Created type: object properties: environment: type: object description: Information about the environment. properties: id: type: string description: The environment's ID. example: 5daabc50-8451-43f6-922d-96b403b4f28e name: type: string description: The environment's name. example: Test Environment uid: type: string format: uid description: The environment's unique ID. example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e getEnvironmentInfo: type: object description: Information about the environment. properties: id: type: string description: The environment's ID. example: 5daabc50-8451-43f6-922d-96b403b4f28e name: type: string description: The environment's name. example: Test Environment owner: type: string description: The ID of environment's owner. example: '12345678' createdAt: type: string format: date-time description: The date and time at which the environment was created. example: '2020-11-05T13:59:22.000Z' updatedAt: type: string format: date-time description: The date and time at which the environment was last updated. example: '2020-11-05T13:59:23.000Z' values: type: array description: Information about the environment's variables. items: anyOf: - $ref: '#/components/schemas/environmentVariables' - $ref: '#/components/schemas/environmentVaultVariables' isPublic: type: boolean description: If true, the environment is public and visible to all users. example: false getEnvironment: title: Successful Response type: object properties: environment: $ref: '#/components/schemas/getEnvironmentInfo' putEnvironment: title: Replace Environment Data type: object properties: environment: type: object description: Information about the environment. properties: name: type: string description: The environment's name. example: Test Environment values: type: array description: Information about the environment's variables. items: anyOf: - $ref: '#/components/schemas/environmentVariables' - $ref: '#/components/schemas/environmentVaultVariables' putEnvironmentResponse: title: Environment Updated type: object properties: environment: type: object description: Information about the environment. properties: id: type: string description: The environment's ID. example: 5daabc50-8451-43f6-922d-96b403b4f28e name: type: string description: The environment's name. example: Test A Environment uid: type: string format: uid description: The environment's unique ID. example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e deleteEnvironment: title: Environment Deleted type: object properties: environment: type: object description: Information about the environment. properties: id: type: string description: The deleted environment's ID. example: 4dfb28a4-9a6c-4ce4-b31a-17c26a8b2cce uid: type: string format: uid description: The deleted environment's unique ID. example: 12345678-4dfb28a4-9a6c-4ce4-b31a-17c26a8b2cce patchEnvironmentAdd: title: Add Variable type: array items: type: object required: - op - path - value properties: op: type: string description: The `add` operation. example: add path: type: string description: The [JSON Pointer syntax](https://datatracker.ietf.org/doc/html/rfc6901) that indicates the entry to update, in `/values/#` format, where `#` is the entry ID. The first record begins at the `0` value. example: /values/1 value: description: The environment variable to add. anyOf: - $ref: '#/components/schemas/environmentVariables' - $ref: '#/components/schemas/environmentVaultVariables' patchEnvironmentName: title: Update Environment Name type: array items: type: object description: Information about the environment. required: - op - path - value properties: op: type: string description: The `replace` operation. example: replace path: type: string description: The `/name` value. example: /name value: type: string description: The environment's updated name. example: Test API Environment patchEnvironmentReplace: title: Update Variable type: array items: type: object required: - op - path - value properties: op: type: string description: The `replace` operation. example: replace path: type: string description: | The [JSON Pointer syntax](https://datatracker.ietf.org/doc/html/rfc6901) that indicates the entry to update, in `/values/#/{value}` format, where: - `#` — The entry ID. The first record begins at the `0` value. - `{value}` — The variable property to update. Accepts `key`, `value`, `type`, and `enable`. example: /values/0/value value: type: string description: The variable's value. example: '{{x-api-key}}' patchEnvironmentRemove: title: Remove Variable type: array items: type: object required: - op - path properties: op: type: string description: The `remove` operation. example: remove path: type: string description: The [JSON Pointer syntax](https://datatracker.ietf.org/doc/html/rfc6901) that indicates the entry to update, in `/values/#` format, where `#` is the entry ID. The first record begins at the `0` value. example: /values/0 patchEnvironmentInfo: type: object description: Information about the environment. properties: id: type: string description: The environment's ID. example: 5daabc50-8451-43f6-922d-96b403b4f28e name: type: string description: The environment's name. example: Test Environment owner: type: string description: The ID of environment's owner. example: '12345678' createdAt: type: string format: date-time description: The date and time at which the environment was created. example: '2020-11-05T13:59:22.000Z' updatedAt: type: string format: date-time description: The date and time at which the environment was last updated. example: '2020-11-05T13:59:23.000Z' values: type: array description: Information about the environment's variables. items: anyOf: - $ref: '#/components/schemas/environmentVariables' - $ref: '#/components/schemas/environmentVaultVariables' uid: type: string format: uid description: The environment's unique ID. example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e patchEnvironmentResponse: title: Environment Updated type: object properties: environment: $ref: '#/components/schemas/patchEnvironmentInfo' patchEnvironment400Error: title: Bad Request type: object properties: title: type: string description: A short summary of the error. example: Not Found status: type: number format: http-status-code description: The error's HTTP status code. example: 404 detail: anyOf: - type: string title: string - type: array title: array items: type: string description: Details about the occurrence of the error. example: We could not find the environment you are looking for type: type: string format: uri description: The error type. example: https://api.postman.com/problems/notFound instance: type: string description: The URI reference that identifies the specific occurrence of the problem. example: /environments/5daabc50-8451-43f6-922d-96b403b4f28e environmentUid: type: string format: uid example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e sortByCreatedAt: type: string enum: - createdAt example: createdAt environmentForkInfo: type: object description: Information about the forked environment. properties: forkId: type: string format: uid description: The forked environment's unique ID. example: 12345678-2fgh78uj-2ee3-8ugc-b678-7742d82e2e1f forkName: type: string description: The forked environment's label. example: my fork createdAt: type: string format: date-time description: The date and time at which the fork was created. example: '2023-11-16T09:18:17.000Z' createdBy: type: string description: The user who created the environment fork. example: Taylor Lee updatedAt: type: string format: date-time description: The date and time at which the fork was last updated. example: '2023-11-16T09:18:17.000Z' environmentForksMeta: type: object description: The response's meta information for paginated results. properties: total: type: number description: The total number of forked environments. example: 6 nextCursor: type: string nullable: true description: The pagination cursor that points to the next record in the results set. example: null getEnvironmentForks: title: Successful Response type: object properties: data: type: array description: A list of the environment's forks. items: $ref: '#/components/schemas/environmentForkInfo' meta: $ref: '#/components/schemas/environmentForksMeta' forkEnvironment: title: Fork Environment type: object required: - forkName properties: forkName: type: string description: The forked environment's label. example: My fork forkEnvironmentResponse: title: Successful Response type: object properties: environment: type: object description: Information about the forked environment. properties: uid: type: string format: uid description: The forked environment's ID. example: 12345678-0fcea3ba-abcf-49c3-9f48-669c208fef25 name: type: string description: The name of the forked environment. example: Testing Environment forkName: type: string description: The forked environment's label. example: Test Fork mergeEnvironmentFork: title: Merge Environment Fork type: object required: - source properties: source: type: string format: uid description: The source environment's unique ID to merge data from. example: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957 deleteSource: type: boolean default: false description: If true, the forked environment will be deleted. example: false mergeEnvironmentForkResponse: title: Successful Response type: object properties: environment: type: object description: Information about the merged environment. properties: uid: type: string format: uid description: The merged environment's ID. example: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957 pullEnvironment: title: Pull Environment Fork Changes type: object required: - source properties: source: type: string format: uid description: The source environment's unique ID to pull data from. example: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957 pullEnvironmentResponse: title: Successful Response type: object properties: environment: type: object description: Information about the merged environment. properties: uid: type: string format: uid description: The merged environment's unique ID. example: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957 governanceGroupSummary: type: object description: Information about a governance group. properties: id: type: string description: The governance group's ID. example: 01JWSGROUP0123456789ABCDEF name: type: string description: The governance group's name. example: Payments workspaces description: type: string description: The governance group's description. example: All payments-related workspaces. type: type: string description: | The governance group type: - `system` — Groups managed by Postman (for example, the default group that applies to all workspaces) and can't be updated or deleted. - `custom` — Groups created and managed by your team. enum: - system - custom example: custom createdBy: type: string description: The ID of the user who created the governance group. example: '12345678' updatedBy: type: string description: The ID of the user who last updated the governance group. example: '12345678' createdAt: type: string format: date-time description: The date and time at which the governance group was created. example: '2026-07-13T10:15:30.000Z' updatedAt: type: string format: date-time description: The date and time at which the governance group was last updated. example: '2026-07-13T11:20:00.000Z' governanceGroupList: type: object description: A paginated list of governance groups. properties: data: type: array description: A list of governance groups. items: $ref: '#/components/schemas/governanceGroupSummary' meta: $ref: '#/components/schemas/meta' governanceGroupCreate: type: object description: Information about the governance group. required: - name properties: name: type: string minLength: 1 maxLength: 255 description: The governance group's name. Must be unique within the team. example: Payments workspaces description: type: string maxLength: 255 description: The governance group's description. example: All payments-related workspaces. governanceGroupId: type: string example: 01JWSGROUP0123456789ABCDEF governanceGroupUpdate: type: object minProperties: 1 additionalProperties: false description: Information about the governance group. properties: name: type: string minLength: 1 maxLength: 255 description: The governance group's name. example: Payments workspaces (v2) description: type: string maxLength: 255 description: The governance group's description. example: Updated description. rulesetAssignmentSummary: type: object description: Information about the ruleset assignment. required: - rulesetId - targetType - targetId properties: rulesetId: type: string description: The assigned ruleset's ID. example: 01JABCDEF0123456789ABCDEFG targetType: type: string description: The assignment target type. enum: - governance_group example: governance_group targetId: type: string description: The target governance group's ID. example: 01JWSGROUP0123456789ABCDEF rulesetAssignmentList: type: object description: A list of ruleset assignments. properties: data: type: array description: The ruleset assignments. items: $ref: '#/components/schemas/rulesetAssignmentSummary' workspaceAssignmentSummary: type: object description: Information about a workspace assigned to a governance group. properties: id: type: string description: The workspace's ID. example: 5b01136d-4231-4b8d-95c8-ef9f7c779dd7 workspaceAssignmentList: type: object description: A paginated list of workspaces assigned to a governance group. properties: data: type: array description: A list of workspaces assigned to the governance group. items: $ref: '#/components/schemas/workspaceAssignmentSummary' meta: $ref: '#/components/schemas/meta' bulkWorkspacesRequest: type: object minProperties: 1 additionalProperties: false description: The workspaces to assign to and unassign from the governance group. properties: create: type: array description: The IDs of the workspaces to assign to the group. items: type: string example: - 5b01136d-4231-4b8d-95c8-ef9f7c779dd7 delete: type: array description: The IDs of the workspaces to unassign from the group. items: type: string example: - 7c22247e-5342-4c9e-a6d9-fa0a8d880ee8 emptyObject: type: object additionalProperties: false description: An empty object indicating the request succeeded. getGroups: title: Postman Groups Information type: object properties: data: type: array description: A list of Postman groups. items: type: object description: Information about the group. properties: id: type: number description: The group's ID. example: 123 teamId: type: number description: The group's Postman team ID. example: 321 name: type: string description: The group's name. example: API Test Group summary: type: string description: The group's summary. example: API testing group. createdBy: type: number description: The ID of ther user who created the group. example: 12345678 createdAt: type: string format: date-time description: The date and time at which the group was created. example: '2024-10-03T14:05:05.000Z' updatedAt: type: string format: date-time description: The date and time at which the group was updated. example: '2024-10-03T14:05:05.000Z' members: type: array description: The group members' IDs. items: type: number example: 12345678 roles: type: array description: The group's roles. items: type: string example: user groupId: type: integer example: 123 getGroup: title: Postman Group Information type: object description: Information about the group. properties: id: type: number description: The group's ID. example: 123 teamId: type: number description: The group's Postman team ID. example: 321 name: type: string description: The group's name. example: API Test Group summary: type: string description: The group's summary. example: API testing group. createdBy: type: number description: The ID of ther user who created the group. example: 12345678 createdAt: type: string format: date-time description: The date and time at which the group was created. example: '2024-10-03T14:05:05.000Z' updatedAt: type: string format: date-time description: The date and time at which the group was updated. example: '2024-10-03T14:05:05.000Z' members: type: array description: The group members' IDs. items: type: number example: 12345678 roles: type: array description: The group's roles. items: type: string example: user managers: type: array description: The group's managers. items: type: number example: 12345678 generateCollectionOptions: type: object description: The advanced creation options and their values. For more details, see Postman's [OpenAPI to Postman Collection Converter OPTIONS documentation](https://github.com/postmanlabs/openapi-to-postman/blob/develop/OPTIONS.md). These properties are case-sensitive. properties: requestNameSource: type: string default: Fallback description: | Determines how the generated collection's requests are named. If the `Fallback` value is passed, then the request is named after one of the following values in the schema: - `summary` - `operationId` - `description` - `url` enum: - Fallback - URL example: Fallback indentCharacter: type: string default: Space description: The option for setting the indentation character type. enum: - Tab - Space example: Space parametersResolution: deprecated: true type: string default: Schema description: Generated collections use examples for parameter generation by default. Any existing collections generated using the schema parameter generation will continue to sync using their existing strategy. example: Schema folderStrategy: type: string default: Paths description: Whether to create folders based on the specification's `paths` or `tags` properties. enum: - Paths - Tags example: Paths includeAuthInfoInExample: type: boolean default: true description: If true, include the authentication parameters in the example request. example: true enableOptionalParameters: type: boolean default: true description: If true, enables optional parameters in the collection and its requests. example: true keepImplicitHeaders: type: boolean default: false description: If true, keep the implicit headers from the OpenAPI specification, which are removed by default. example: false includeDeprecated: type: boolean default: true description: If true, includes all deprecated operations, parameters, and properties in generated collection. example: true alwaysInheritAuthentication: type: boolean default: false description: Whether authentication details should be included in all requests, or always inherited from the collection. example: false nestedFolderHierarchy: type: boolean default: false description: If true, creates subfolders in the generated collection based on the order of the endpoints' tags. example: false jsonSchema: title: JSON Schema type: object required: - type - input properties: type: type: string description: The `json` type value. enum: - json example: json input: type: object description: An object that contains a valid JSON OpenAPI definition. For more information, read the [OpenAPI documentation](https://swagger.io/docs/specification/basic-structure/). options: $ref: '#/components/schemas/generateCollectionOptions' jsonStringified: title: JSON Stringified type: object required: - type - input properties: type: type: string description: The `string` type value. enum: - string example: string input: type: string description: The stringified OpenAPI definition. example: |- { "openapi": "3.0.0", "servers": [ { "url": "example.com" } ], "info": { "contact": { "name": "Jon" }, "version": "1.0.0", "title": "Sample API", "description": "Buy or rent spacecrafts" }, "paths": { "/spacecrafts/{spacecraftId}": { "parameters": [ { "name": "spacecraftId", "description": "The unique identifier of the spacecraft", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SpacecraftId" } } ], "get": { "summary": "Read a spacecraft", "responses": { "200": { "description": "The spacecraft corresponding to the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Spacecraft" } } } }, "404": { "description": "No spacecraft found for the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "#/components/schemas/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key" } } }, "security": [ { "ApiKey": [] } ] } options: $ref: '#/components/schemas/generateCollectionOptions' importExportFile: type: object required: - type - input properties: type: type: string description: The `file` type value. enum: - file example: file input: type: string description: A .zip file containing the definition file. format: binary importOpenApiDefinition: title: Successful Response type: object properties: collections: type: array description: A list of the collections created from the imported OpenAPI definition. items: type: object properties: id: type: string description: The collection's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: type: string description: The collection's name. example: Test Collection uid: type: string format: uid description: The collection's unique ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 import400Error: title: Bad Request anyOf: - $ref: '#/components/schemas/commonErrorNameMessage' - $ref: '#/components/schemas/commonErrorNameMessageDetails' partnerEmailAddress: type: string format: email minLength: 1 maxLength: 254 description: A partner's email address. example: alex.cruz@example.com managePartnerWorkspaceInvitesTargetObjectEmails: type: object description: The target on which to perform the action. required: - emails properties: emails: type: array minItems: 1 uniqueItems: true description: A list of the partners' email addresses. items: $ref: '#/components/schemas/partnerEmailAddress' managePartnerWorkspaceInvitesInvitePartner: title: Invite Partners type: object description: Invite partners to a Partner Workspace. required: - action - targetEntity - targetEntityId - roleId - target properties: action: type: string description: The `invite_partner` action. enum: - invite_partner example: invite_partner targetEntity: type: string description: The `workspace` value. enum: - workspace example: workspace targetEntityId: type: string maxLength: 60 minLength: 1 description: The Partner Workspace's ID. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 roleId: type: string description: | The role ID to assign to invited partners: - `4` — Viewer - `5` — Editor - `6` — Viewer and Partner Lead - `7` — Editor and Partner Lead enum: - '4' - '5' - '6' - '7' example: '5' target: $ref: '#/components/schemas/managePartnerWorkspaceInvitesTargetObjectEmails' partnerUserId: type: string minLength: 1 maxLength: 25 description: The partner's ID. example: '56781234' managePartnerWorkspaceInvitesTargetObjectUserId: description: The target on which to perform the action. anyOf: - title: Remove from Workspace type: object description: The target on which to perform the action. required: - userIds properties: userIds: type: array uniqueItems: true minItems: 1 description: A list of partner user IDs to remove from the Partner Workspace. items: $ref: '#/components/schemas/partnerUserId' - title: Remove from Team Partnership type: object description: The target on which to perform the action. required: - userIds properties: userIds: type: array uniqueItems: true minItems: 1 description: A list of partner publishers' team IDs. items: $ref: '#/components/schemas/partnerUserId' managePartnerWorkspaceInvitesRemovePartner: title: Remove Partners type: object description: The request body for removing partners from a Partner Workspace. required: - action - targetEntity - targetEntityId - target properties: targetEntity: type: string description: The `workspace` value. enum: - workspace example: workspace targetEntityId: type: string minLength: 1 maxLength: 60 description: The Partner Workspace ID from which to remove partners. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 action: type: string description: The `remove_partner` action. enum: - remove_partner example: remove_partner target: $ref: '#/components/schemas/managePartnerWorkspaceInvitesTargetObjectUserId' managePartnerWorkspaceInvitesRemovePartnerTeam: title: Remove Partner From Partnership type: object description: The request body for removing partners from partnership with a team. required: - action - targetEntity - targetEntityId - target properties: targetEntity: type: string description: The `team` value. enum: - team example: team targetEntityId: type: string minLength: 1 maxLength: 60 description: The team ID from which to remove partners. example: '123' action: type: string description: The `remove_partner` action. enum: - remove_partner example: remove_partner target: $ref: '#/components/schemas/managePartnerWorkspaceInvitesTargetObjectUserId' managePartnerWorkspaceInvitesInvitePartnerResponse: title: Invite Partner Response type: object properties: targetEntity: type: string description: The target entity. example: workspace targetEntityId: type: string description: The target entity's ID. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 roleId: type: string description: The role ID assigned to the users. example: '5' action: type: string description: The action peformed. example: invite_partner roleDisplayName: type: string description: The assigned role's display name. enum: - Viewer - Editor - Viewer and Partner Lead - Editor and Partner Lead example: Editor results: type: array description: A list of the action results for each email address. items: type: object properties: email: type: string format: email description: The invited user's email address. example: alex.cruz@example.com status: type: string description: | The invitation status: - `EMAIL_SENT` — An invitation email was sent. - `ALREADY_INVITED` — The user already has a pending invitation. - `PARTNER_ADDED` — The existing user was added to the workspace directly. - `FAILED` — The invitation failed. enum: - EMAIL_SENT - ALREADY_INVITED - PARTNER_ADDED - FAILED example: EMAIL_SENT userId: type: string description: The user ID. This only returns for the `PARTNER_ADDED` status. example: '56781234' message: type: string description: A response message. example: Partner added to workspace invitationLink: type: string format: uri description: An invitation link. This only returns for the `EMAIL_SENT` and `ALREADY_INVITED` statuses. example: https://go.postman.com/invite-signup?invite_code=XXX managePartnerWorkspaceInvitesRemovePartnerResponse: title: Remove Partner Response type: object properties: targetEntity: type: string description: The target entity type. example: workspace targetEntityId: type: string description: The target entity's ID. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 action: type: string description: The action performed. example: remove_partner results: type: array description: A list of the action results. items: type: object properties: error: type: string description: If the endpoint returns the `FAILED` status, the error message detailing the error. example: Partner information not found message: type: string description: A response message. example: Failed to remove partner from all workspaces status: type: string description: | The removal status: - `REMOVED` — The partner was successfully removed. - `FAILED` — The partner's removal failed. enum: - REMOVED - FAILED example: REMOVED userId: type: string description: The user ID. example: '56781234' getAuthenticatedUser: title: Successful Response type: object properties: user: type: object description: Information about the authenticated user. properties: id: type: number description: The user's Postman ID. example: 12345678 sub: type: string description: The authenticated user's ID. This ID is unique to the user and isn't associated with any Postman teams. Can return in UUID or ID format. example: 4d71435e-0e67-45b9-9d4c-e3262166d157 username: type: string description: The user's username. example: taylor-lee email: type: string format: email description: The user's email address. example: taylor.lee@example.com fullName: type: string description: The user's full name. example: Taylor Lee avatar: type: string format: url nullable: true description: The user's avatar image URL. example: https://example.com/user/r5u9qpvmujfjf6lbqmga.jpg isPublic: type: boolean description: If true, the user's information is public and visible to all users. example: true emailVerified: type: boolean description: If true, the user email address is verified by Postman. example: true teamId: type: integer description: The team ID the user is assigned to. This returns a `0` value if the user is not assigned to a team. example: 123 teamName: type: string description: The name of the team the user is assigned to. example: Test Team teamDomain: type: string description: The team's Postman domain ID. example: test-team roles: type: array description: A list of the user's assigned [roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles). items: type: string default: user example: user operations: type: array description: Information about operations and their usage limits. This object does not return for users with the [Guest and Partner role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles). items: type: object properties: limit: type: number description: The operation's limit value. example: 1000000 name: type: string description: The operation's name. example: mock_usage overage: type: number description: The operation's overage value. example: 0 usage: type: number description: The operation's current usage value. example: 110276 teamIdResultsQuery: type: string example: 1b96f65f-8d23-4e1d-b5e2-055992c3b8cbd2567dfa09a9 mockServerDelayData: type: object nullable: true description: Information about the mock server's simulated network delay settings. This returns a null value if there are no configured network delay settings. properties: type: type: string description: The `fixed` value. example: fixed enum: - fixed preset: type: string description: | The simulated fixed network delay value: - `1` — 2G (300 ms). - `2` — 3G (100 ms). The object does not return this value for custom delay values. example: '2' enum: - '1' - '2' duration: type: integer description: For custom network delays, the custom configured delay, in milliseconds. example: 100 mockServerConfigData: type: object description: Information about the mock server's configuration. additionalProperties: true properties: delay: $ref: '#/components/schemas/mockServerDelayData' headers: type: array description: A list of the mock server's headers. items: type: string example: [] matchBody: type: boolean description: If true, match the request body. example: false matchHeader: type: boolean description: If true, match the request headers. example: false matchQueryParams: type: boolean description: If true, match query parameters. example: true matchWildcards: type: boolean description: If true, use wildcard variable matching. example: true serverResponseId: type: string nullable: true description: The ID of mock server's default response for requests. All calls to the mock server will return the defined response. example: 94d0f5d9-dbdf-4046-9a7d-a11f9b78ac65 mockServerData: type: object description: Information about the mock server. properties: id: type: string description: The mock server's ID. example: e3d951bf-873f-49ac-a658-b2dcb91d3289 owner: type: string description: The ID of mock server's owner. example: '12345678' uid: type: string format: uid description: The mock server's unique ID. example: 12345678-e782b64e-406b-4a6c-8fe9-9ebe84aeb706 collection: type: string description: The unique ID of the mock's associated collection. example: 12345678-39fee52f-b806-3ffa-1173-00a6f5b183dc mockUrl: type: string format: url description: The mock server URL. example: https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io name: type: string description: The mock server's name. example: Test Mock config: $ref: '#/components/schemas/mockServerConfigData' createdAt: type: string format: date-time description: The date and time at which the mock server was created. example: '2022-06-09T19:00:39.000Z' updatedAt: type: string format: date-time description: The date and time at which the mock server was last updated. example: '2022-06-09T19:00:39.000Z' isPublic: type: boolean description: If true, the mock server is public and visible to all users. This field does not indicate the mock server's access control status. example: false deactivated: type: boolean description: If true, the mock server is not active. Mock servers deactivate when a linked collection or environment is deleted. example: false environment: type: string description: The mock server's associated environment ID. example: 1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524 getMocks: title: Get Mock Servers type: object properties: mocks: type: array description: A list of mock servers. items: $ref: '#/components/schemas/mockServerData' mock500Error: title: Internal Server Error type: object properties: error: type: object description: Information about the error. properties: type: type: string description: The error name. example: serverResponseNotFoundError message: type: string description: The error message. example: We could not find the mock server response you are looking for. createMock: title: Create Mock type: object properties: mock: type: object description: Information about the mock server to create. required: - collection properties: collection: type: string format: uid description: The unique ID of the mock's associated collection. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 environment: type: string format: uid description: The unique ID of the mock's associated environment. example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e name: type: string description: The mock server's name. example: Test Mock private: type: boolean default: false description: If true, the mock server is set private. By default, mock servers are public and can receive requests from anyone and anywhere. example: true mockCreateUpdateData: type: object description: Information about the mock server. properties: id: type: string description: The mock server's ID. example: e3d951bf-873f-49ac-a658-b2dcb91d3289 owner: type: string description: The ID of mock server's owner. example: '12345678' uid: type: string format: uid description: The mock server's unique ID. example: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289 collection: type: string description: The unique ID of the mock's associated collection. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 mockUrl: type: string format: url description: The mock server URL. example: https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io name: type: string description: The mock server's name. example: Test Mock config: $ref: '#/components/schemas/mockServerConfigData' createdAt: type: string format: date-time description: The date and time at which the mock server was created. example: '2022-06-09T19:00:39.000Z' updatedAt: type: string format: date-time description: The date and time at which the mock server was last updated. example: '2022-06-09T19:00:39.000Z' environment: type: string description: The unique ID of the mock's associated environment. example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e mockCreateUpdateResponse: title: Mock Create/Update Response type: object properties: mock: $ref: '#/components/schemas/mockCreateUpdateData' mockId: type: string example: e3d951bf-873f-49ac-a658-b2dcb91d3289 getMock: title: Get Mock Server type: object properties: mock: $ref: '#/components/schemas/mockServerData' updateMockConfigData: type: object description: The mock server's configuration settings. properties: serverResponseId: type: string nullable: true description: The server response ID. This sets the given server response as the default response for each request. To deactivate a server response, pass a null value. example: 9a291bbe-dc0a-44ba-a3c8-6dbd06a61460 updateMock: title: Update Mock type: object properties: mock: type: object description: The mock server fields to update. properties: name: type: string description: The mock server's name. example: Test Mock environment: type: string format: uid description: The associated environment's unique ID. example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e description: type: string description: The mock server's description. example: This is a test mock server. private: type: boolean default: false description: If true, the mock server is set private. By default, mock servers are public and can receive requests from anyone and anywhere. example: true versionTag: type: string description: The API's version tag ID. example: abf07d3d-f8ec-47d4-8015-9fe83078b4ec collection: type: string description: The ID of the collection associated with the mock server. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 config: $ref: '#/components/schemas/updateMockConfigData' deleteMock: title: Mock Deleted type: object properties: mock: type: object description: Information about the mock server. properties: id: type: string description: The mock server's ID. example: e3d951bf-873f-49ac-a658-b2dcb91d3289 uid: type: string format: uid description: The mock server's unique ID. example: 12345678-e782b64e-406b-4a6c-8fe9-9ebe84aeb706 limitDefault100: type: number default: 100 example: 3 mockResponseStatusCode: type: number example: 500 mockResponseType: type: string example: success mockRequestMethod: type: string example: post mockRequestPath: type: string example: /animals?type=Dog mockSortServedAt: type: string enum: - servedAt example: servedAt mockInclude: type: string example: request.headers,request.body,response.headers,response.body mockServerResponseHeadersData: type: object properties: key: type: string description: The request header's key value. example: Content-Type value: type: string description: The request header's value. example: application/json mockCallLogRequestBodyData: type: object description: The request's body information. properties: mode: type: string description: The request body's media type (mode). example: raw data: type: string description: The request body's contents. example: '{"type":"hamster","breed":"Syrian Hamster","age":"1 month"}' mockCallLogRequestData: type: object description: The server response's request information. properties: method: type: string description: The request method. example: POST path: type: string description: The request's path. example: /animals headers: type: array description: The request's headers. items: $ref: '#/components/schemas/mockServerResponseHeadersData' body: $ref: '#/components/schemas/mockCallLogRequestBodyData' callLogsResponseHeadersData: type: object properties: description: type: object description: The response header's description information. properties: content: type: string description: The response header description's content. example: '' type: type: string description: The response header description's media type. example: text/plain key: type: string description: The response header's name. example: content-type value: type: string description: The response header's value. example: application/json mockServerResponseBodyData: type: object description: The response's body information. properties: data: type: string description: The response body's contents. example: "{\n\t\"message\": \"Malformed request. You need to send gender as part of the request.\"\n}" mockCallLogResponseData: type: object description: The server response's response information. properties: type: type: string description: The type of response. example: error statusCode: type: number description: The response's status code. example: 400 headers: type: array description: The response's headers. items: $ref: '#/components/schemas/callLogsResponseHeadersData' body: $ref: '#/components/schemas/mockServerResponseBodyData' mockCallLogData: type: object description: Information about the mock server's server response. properties: id: type: string description: The server response's ID. example: 0f63f54d-665e-436a-95b4-c1302d7685a9-3925 responseName: type: string description: The server response's name. example: Bad Request servedAt: type: string format: date-time description: The date and time at which the server response was served. example: '2022-01-17T06:19:22.000Z' request: $ref: '#/components/schemas/mockCallLogRequestData' response: $ref: '#/components/schemas/mockCallLogResponseData' getMockCallLogs: title: Get Call Logs type: object properties: call-logs: type: array description: A list of call logs. items: $ref: '#/components/schemas/mockCallLogData' meta: $ref: '#/components/schemas/meta' publishUnpublishMockResponse: title: Mock Published/Unpublished type: object properties: mock: type: object description: Information about the mock server. properties: id: type: string description: The mock server's ID. example: e3d951bf-873f-49ac-a658-b2dcb91d3289 getMockServerResponsesData: type: object properties: id: type: string description: The server response's ID. example: 965cdd16-fe22-4d96-a161-3d05490ac421 name: type: string description: The server response's name. example: Internal Server Error statusCode: type: number description: The server response's 5xx HTTP response code. example: 500 createdAt: type: string format: date-time description: The date and time at which the server response was created. example: '2022-08-02T14:57:44.000Z' updatedAt: type: string format: date-time description: The date and time at which the server response was last updated. example: '2022-08-02T14:57:44.000Z' createdBy: type: string description: The user ID of the user who created the server response. example: '12345678' updatedBy: type: string description: The user ID of the user who last updated the server response. example: '12345678' getMockServerResponses: title: Successful Response type: array description: A list of the mock server's responses. items: $ref: '#/components/schemas/getMockServerResponsesData' mockServerResponse404Error: title: Bad Request type: object properties: error: type: object description: Information about the error. properties: name: type: string description: The error name. example: serverResponseNotFoundError header: type: string description: Information about the error. example: Unable to find mock server response message: type: string description: The error message. example: We could not find the mock server response you are looking for. mockServerResponseLanguage: type: string nullable: true description: The server response's body language type. enum: - text - javascript - json - html - xml example: json createMockServerResponse: title: Create Mock Server Response type: object properties: serverResponse: type: object description: Information about the server response to create. required: - name - statusCode properties: name: type: string description: The server response's name. example: Internal Server Error statusCode: type: integer description: The server response's 5xx HTTP response code. This property only accepts 5xx values. example: 500 headers: type: array description: The server response's request headers, such as Content-Type, Accept, encoding, and other information. items: $ref: '#/components/schemas/mockServerResponseHeadersData' language: $ref: '#/components/schemas/mockServerResponseLanguage' body: type: string description: The server response's body that returns when calling the mock server. example: |- { "message": "Something went wrong; try again later." } mockServerResponse: title: Successful Response type: object description: Information about the mock server's response. additionalProperties: true properties: createdAt: type: string format: date-time description: The date and time at which the server response was created. example: '2022-08-02T14:57:44.000Z' updatedAt: type: string format: date-time description: The date and time at which the server response was last updated. example: '2022-08-02T14:57:44.000Z' id: type: string description: The server response's ID. example: 965cdd16-fe22-4d96-a161-3d05490ac421 name: type: string description: The server response's name. example: Internal Server Error statusCode: type: number description: The server response's 5xx HTTP response code. example: 500 headers: type: array description: The server response's request headers key-value pairs, such as Content-Type, Accept, encoding, and other information. items: $ref: '#/components/schemas/mockServerResponseHeadersData' language: $ref: '#/components/schemas/mockServerResponseLanguage' body: type: string description: The server response's body that returns when calling the mock server. example: |- { "message": "Something went wrong; try again later." } createdBy: type: string description: The user ID of the user who created the server response. example: '12345678' updatedBy: type: string description: The user ID of the user who last updated the server response. example: '12345678' mock: type: string description: The associated mock server's ID. example: 32cd624d-9986-4f20-9048-89252f722269 serverResponseId: type: string example: 965cdd16-fe22-4d96-a161-3d05490ac421 updateMockServerResponse: title: Update Mock Server Response type: object properties: serverResponse: type: object description: The server response fields to update. properties: name: type: string description: The server response's name. example: Internal Server Error statusCode: type: integer description: The server response's 5xx HTTP response code. This property only accepts [5xx values](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml). example: 500 headers: type: array description: The server response's request headers, such as Content-Type, Accept, encoding, and other information. items: $ref: '#/components/schemas/mockServerResponseHeadersData' language: $ref: '#/components/schemas/mockServerResponseLanguage' body: type: string description: The server response's body that returns when you call the mock server. example: |- { "message": "Something went wrong; try again later." } deleteMockServerResponse: title: Server Response Deleted type: object description: Information about the deleted server response. properties: id: type: string description: The server response's ID. example: 965cdd16-fe22-4d96-a161-3d05490ac421 name: type: string description: The server response's name. example: Internal Server Error statusCode: type: number description: The server response's 5xx HTTP response code. example: 500 headers: type: array description: The server response's request headers, such as Content-Type, Accept, encoding, and other information. items: $ref: '#/components/schemas/mockServerResponseHeadersData' language: $ref: '#/components/schemas/mockServerResponseLanguage' body: type: string description: The server response's body that returns when calling the mock server. example: |- { "message": "Something went wrong; try again later." } createdBy: type: string description: The user ID of the user who created the server response. example: '12345678' updatedBy: type: string description: The user ID of the user who last updated the server response. example: '12345678' createdAt: type: string format: date-time description: The date and time at which the server response was created. example: '2022-09-21T20:20:09.000Z' active: type: boolean example: false owner: type: integer example: 12345678 limitDefault25: type: integer default: 25 maximum: 25 example: 10 getMonitorsData: type: object description: Information about the monitor. properties: id: type: string description: The monitor's ID. example: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: type: string description: The monitor's name. example: Test Monitor active: type: boolean description: Whether the monitor is active (`true`) or inactive (`false`). example: true uid: type: string format: uid description: The monitor's unique ID. example: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 owner: type: integer description: The ID of the user that created the monitor. example: 12345678 collectionUid: type: string description: The unique ID of the monitor's associated collection. example: 12345678-d35c5bfa-380e-4e98-9052-4eaf3bd0f14a environmentUid: type: string description: The unique ID of the monitor's associated environment. example: 12345678-9ce0605e-e7cb-40dc-8074-2f6a69252905 metaNetCursorLimit: type: object description: The response's meta information for paginated results. properties: nextCursor: type: string nullable: true description: The pagination cursor that points to the next record in the results set. example: bmV4dDppZDpZWEpqYUdsMllXeEVRaXhtWldWa2MxOHlNREkxWHpFc01UTXpNelE0 limit: type: integer description: The maximum number of records in the paginated response. example: 25 getMonitors: title: Successful Response type: object properties: monitors: type: array description: A list of monitors. items: $ref: '#/components/schemas/getMonitorsData' meta: $ref: '#/components/schemas/metaNetCursorLimit' monitorRetry: title: Monitor Retry Settings type: object description: Information about the monitor's retry settings. properties: attempts: type: number minimum: 1 maximum: 2 description: The number of times to reattempt a monitor run if it fails or errors. This may impact your [monitor usage](https://learning.postman.com/docs/monitoring-your-api/monitor-usage/#view-monitor-usage). example: 1 monitorFollowRedirects: title: Monitor Follow Redirects type: boolean description: If true, follow redirects enabled. example: true monitorRequestDelay: title: Monitor Request Delay type: integer minimum: 0 maximum: 900000 description: The monitor's delay between requests, in milliseconds, as a whole number. A `0` value means no delay. The maximum value is `600000` (10 minutes) on free plans and `900000` (15 minutes) on paid plans. This value is checked only when the value changes. example: 1 monitorRequestTimeout: title: Monitor Request Timeout type: integer nullable: true minimum: 1 maximum: 900000 description: The monitor's request timeout, in milliseconds, as a whole number. A `null` value means no timeout, and so does omitting it when creating a monitor. A monitor with no timeout returns a `null` value. The maximum value is `600000` (10 minutes) on free plans and `900000` (15 minutes) on paid plans, checked only when the value changes. example: 3000 monitorStrictSSL: title: Monitor Strict SSL type: boolean description: If true, strict SSL enabled. example: true monitorCollectionItemId: title: Monitor Collection Item ID type: string maxLength: 60 pattern: ^(?:[0-9]{1,23}-)?[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^[0-9a-f]{24}$ description: | The collection item's ID: - For a collection that contains only HTTP requests, use the item's UID in `-` format (for example, `12345678-5daabc50-8451-45f6-922d-96b403b4f28e`). An ID without the `ownerId` prefix is also accepted. - For a collection that contains GraphQL or gRPC requests, use the item's 24 character hexadecimal ID (for example, `66f1c0e2a1b2c3d4e5f60718`). Letters must be lowercase. example: 12345678-5daabc50-8451-45f6-922d-96b403b4f28e monitorRequestSelectionPayload: title: Monitor Request Selection Payload type: object nullable: true additionalProperties: false required: - selectedItems description: The ordered subset of the monitor's collection to run. If set, the monitor runs exactly these items in the given order instead of the full collection. Pass a `null` value to clear the selection and run the full collection again. properties: selectedItems: type: array minItems: 1 description: The collection items to run, in run order. Each entry's position in this array is its position in the run, not the collection's ordering. Each item must exist in the monitor's collection, or the request returns an HTTP `400 Bad Request` error. items: type: object additionalProperties: false required: - id properties: id: $ref: '#/components/schemas/monitorCollectionItemId' monitorOptionsPayload: title: Monitor Options Payload type: object minProperties: 1 description: Information about the monitor's option settings. properties: followRedirects: $ref: '#/components/schemas/monitorFollowRedirects' requestDelay: $ref: '#/components/schemas/monitorRequestDelay' requestTimeout: $ref: '#/components/schemas/monitorRequestTimeout' strictSSL: $ref: '#/components/schemas/monitorStrictSSL' requestSelection: $ref: '#/components/schemas/monitorRequestSelectionPayload' monitorSchedule: title: Monitor Schedule type: object description: Information about the monitor's schedule. properties: cron: type: string description: | The monitor's run frequency, based on the given POSIX cron pattern. For example: - Every 5 minutes — `*/5 * * * *` - Every 30 minutes — `*/30 * * * *` - Every hour — `0 */1 * * *` - Every 6 hours — `0 */6 * * *` - Every day at 5 pm — `0 17 * * *` - Every Monday at 12 pm — `0 12 * * MON` - Every weekday (Mon — Fri) at 6 am — `0 6 * * MON-FRI` example: '*/5 * * * *' timezone: type: string description: The monitor's [timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). example: America/Chicago monitorDistribution: title: Monitor Distribution Settings type: array description: A list of the monitor's [geographic regions](https://learning.postman.com/docs/monitoring-your-api/setting-up-monitor/#add-regions). items: type: object properties: region: type: string description: The assigned distribution region. enum: - us-east - us-west - ap-southeast - ca-central - eu-central - sa-east - uk - us-east-staticip - us-west-staticip example: us-west monitorNotifications: title: Monitor Notifications type: object description: Information about the monitor's notification settings. properties: onError: type: array description: A list of recipients to notify when the monitor errors. items: type: object properties: email: type: string format: email description: The email address of the user to notify on monitor error. example: taylor.lee@example.com onFailure: type: array description: A list of recipients to notify when the monitor fails. items: type: object properties: email: type: string format: email description: The email address of the user to notify on monitor failure. example: taylor.lee@example.com createMonitorPayload: type: object description: Information about the monitor. required: - name - collection - schedule properties: name: type: string description: The monitor's name. example: Test Monitor active: type: boolean default: true description: If true, the monitor is active and makes calls to the specified URL. example: true notificationLimit: type: number minimum: 1 maximum: 99 description: Stop email notifications after the given number consecutive failures. example: 1 collection: type: string description: The unique ID of the monitor's associated collection. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 environment: type: string description: The unique ID of the monitor's associated environment. example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e retry: $ref: '#/components/schemas/monitorRetry' options: $ref: '#/components/schemas/monitorOptionsPayload' schedule: $ref: '#/components/schemas/monitorSchedule' distribution: $ref: '#/components/schemas/monitorDistribution' notifications: $ref: '#/components/schemas/monitorNotifications' createMonitor: title: Create Monitor type: object properties: monitor: $ref: '#/components/schemas/createMonitorPayload' createUpdateMonitorResponseData: type: object description: Information about the monitor. properties: id: type: string description: The monitor's ID. example: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: type: string description: The monitor's name. example: Test Monitor active: type: boolean default: true description: If true, the monitor is active and makes calls to the specified URL. example: true uid: type: string format: uid description: The monitor's unique ID. example: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 createUpdateMonitorResponse: type: object properties: monitor: $ref: '#/components/schemas/createUpdateMonitorResponseData' monitorId: type: string example: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 monitorCollectionStructureItem: title: Monitor Collection Structure Item type: object additionalProperties: false required: - id description: | A folder or request in the collection's item tree: - A folder has an `id` and an `item` array. - A request has an `id` and no `item` array, and can include its `name` and `method`. properties: id: $ref: '#/components/schemas/monitorCollectionItemId' name: type: string maxLength: 255 description: If the item is a request, the request's name. example: Echo method: type: string maxLength: 10 description: If the item is a request, the request's HTTP method. example: POST item: type: array description: If the item is a folder, the folder's items, in collection order. Can be empty. Folders can be nested up to 50 levels deep. items: type: object description: A nested folder or request, with the same fields as this item. monitorRequestSelection: title: Monitor Request Selection type: object nullable: true additionalProperties: false required: - selectedItems - meta description: The ordered subset of the monitor's collection that the monitor runs, in run order, instead of the full collection. properties: selectedItems: type: array minItems: 1 description: The collection items the monitor runs, in run order. Each entry's position in this array is its position in the run, not the collection's ordering. items: type: object additionalProperties: false required: - id - type properties: id: $ref: '#/components/schemas/monitorCollectionItemId' type: type: string enum: - request - folder description: The type of collection item. example: request meta: type: object additionalProperties: false required: - collectionStructure description: Additional request-selection metadata, including the collection's structure at the time the selection was made. properties: collectionStructure: type: array minItems: 1 description: A snapshot of the collection's complete item tree, in collection order and minimal collection format, that Postman takes each time the selection is set or changed. Later changes to the collection are compared against it, so the monitor's notifications can report requests added to or removed from the collection since the selection was set. items: $ref: '#/components/schemas/monitorCollectionStructureItem' monitorOptions: title: Monitor Options type: object description: Information about the monitor's option settings. properties: followRedirects: $ref: '#/components/schemas/monitorFollowRedirects' requestDelay: $ref: '#/components/schemas/monitorRequestDelay' requestTimeout: $ref: '#/components/schemas/monitorRequestTimeout' strictSSL: $ref: '#/components/schemas/monitorStrictSSL' requestSelection: $ref: '#/components/schemas/monitorRequestSelection' monitorRunAssertionStats: type: object description: Information about the monitor's tests. properties: total: type: number description: The total number of tests performed. example: 5 failed: type: number description: The total number of test failures. example: 0 monitorRunRequestsStats: type: object description: Information about the monitor's requests. properties: total: type: number description: The total number of requests. example: 3 failed: type: number description: The number of request failures. example: 0 monitorRunStats: title: Monitor Run Stats type: object description: Information about the monitor run's stats. properties: assertions: $ref: '#/components/schemas/monitorRunAssertionStats' requests: $ref: '#/components/schemas/monitorRunRequestsStats' runCount: type: integer description: The number of monitor runs across the selected monitor regions. example: 3 errorCount: type: integer description: The number of errors encountered during the monitor's run. example: 2 abortedCount: type: integer description: The number of runs terminated. example: 1 responseLatency: type: integer description: The total time it took to run the monitor, in milliseconds. example: 850 responseSize: type: integer description: The total response size. This includes the runs in all the selected regions. example: 2048 monitorLastRun: type: object description: Information about the monitor's previous run. properties: status: type: string description: The monitor's status after its last run. example: success startedAt: type: string format: date-time description: The date and time at which the monitor's previous run started. example: '2025-06-17T18:39:52.852Z' finishedAt: type: string format: date-time description: The date and time at which the monitor's previous run completed. example: '2025-06-17T18:39:53.707Z' stats: $ref: '#/components/schemas/monitorRunStats' getMonitorData: type: object description: Information about the monitor. properties: id: type: string description: The monitor's ID. example: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: type: string description: The monitor's name. example: Test Monitor uid: type: string format: uid description: The monitor's unique ID. example: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 owner: type: integer description: The ID of monitor's owner. example: 12345678 active: type: boolean default: true description: If true, the monitor is active and makes calls to the specified URL. example: true notificationLimit: type: number minimum: 1 maximum: 99 description: Stop email notifications after the given number consecutive failures. example: 1 collectionUid: type: string format: uid description: The unique ID of the monitor's associated collection. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 environmentUid: type: string format: uid description: The unique ID of the monitor's associated environment. example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e jobId: type: string description: The job ID of the monitor's latest run. example: e72dc3de-e4ac-407c-b1cc-2c5b6efced68 options: $ref: '#/components/schemas/monitorOptions' notifications: $ref: '#/components/schemas/monitorNotifications' distribution: $ref: '#/components/schemas/monitorDistribution' schedule: type: object description: Information about the monitor's schedule. properties: cron: type: string description: The monitor's POSIX cron frequency value. example: 0 0 * * * * nextRun: type: string format: date-time description: The date and time of monitor's next scheduled run. example: '2025-06-18T05:00:00.000Z' timezone: type: string description: The monitor's timezone. example: America/Chicago retry: $ref: '#/components/schemas/monitorRetry' lastRun: $ref: '#/components/schemas/monitorLastRun' getMonitor: title: Successful Response type: object properties: monitor: $ref: '#/components/schemas/getMonitorData' updateMonitorPayload: type: object description: Information about the monitor. properties: name: type: string description: The monitor's name. example: Test Monitor active: type: boolean default: true description: If true, the monitor is active and makes calls to the specified URL. example: true notificationLimit: type: number minimum: 1 maximum: 99 description: Stop email notifications after the given number consecutive failures. example: 1 retry: $ref: '#/components/schemas/monitorRetry' options: $ref: '#/components/schemas/monitorOptionsPayload' schedule: $ref: '#/components/schemas/monitorSchedule' distribution: $ref: '#/components/schemas/monitorDistribution' notifications: $ref: '#/components/schemas/monitorNotifications' updateMonitor: title: Update Monitor type: object properties: monitor: $ref: '#/components/schemas/updateMonitorPayload' deleteMonitorData: type: object description: Information about the monitor. properties: id: type: string description: The monitor's ID. example: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 uid: type: string format: uid description: The monitor's unique ID. example: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 deleteMonitor: title: Monitor Deleted type: object properties: monitor: $ref: '#/components/schemas/deleteMonitorData' async: type: boolean default: false example: false monitorRunInfo: title: Monitor Run Information type: object description: Information about the monitor. properties: jobId: type: string description: The monitor's run job ID. example: 1ecee76a-e14e-47c0-bddc-256bf690c407 collectionUid: type: string format: uid description: The unique ID of the monitor's associated collection. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 environmentUid: type: string format: uid description: The unique ID of the monitor's associated environment. example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e monitorId: type: string description: The monitor's ID. example: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: type: string description: The monitor's name. example: Test Monitor status: type: string description: The monitor run's status. example: success startedAt: type: string format: date-time description: The date and time at which the monitor run began. example: '2022-06-17T19:50:04.019Z' finishedAt: type: string format: date-time description: The date and time at which the monitor's run completed. example: '2022-06-17T19:50:06.439Z' monitorRunRequests: title: Monitor Run Requests type: object description: Information about the monitor run's requests. properties: method: type: string description: The HTTP request method. example: POST url: type: string format: url description: The request's URL. example: http://echo.postman.com/post body: type: object description: Information about the request body, such as Content-Length. additionalProperties: true headers: type: object description: Information about the request headers, such as Content-Type, Accept, encoding, and other information. additionalProperties: true timestamp: type: string description: The date and time of the request. example: '2016-12-04T14:30:26.025Z' monitorRunResponses: title: Monitor Run Responses type: object description: Information about the monitor run's response. properties: body: type: object description: Information about the request body, such as Content-Length. additionalProperties: true code: type: number description: The response's HTTP status code. example: 200 headers: type: object description: Information about the response headers, such as Content-Type, Accept, encoding, and other information. additionalProperties: true responseSize: type: number description: The response size, in bytes. example: 298 responseTime: type: number description: The response time, in milliseconds. example: 26 monitorRunErrorsData: type: object additionalProperties: true properties: name: type: string description: The error name. example: TypeError message: type: string description: The error message. example: Cannot read property 'lat' of undefined monitorRunErrors: title: Monitor Run Errors type: array description: If the execution encounter errors, a list of errors and their information. items: $ref: '#/components/schemas/monitorRunErrorsData' monitorRunExecutionsData: type: object properties: id: type: number description: The execution ID. example: 1 item: type: object description: Information about the executed item. properties: name: type: string description: The executed item's name. example: Sample POST Request request: $ref: '#/components/schemas/monitorRunRequests' response: $ref: '#/components/schemas/monitorRunResponses' errors: $ref: '#/components/schemas/monitorRunErrors' monitorRunExecutions: title: Monitor Run Executions type: array description: Information about the monitor run's executions. items: $ref: '#/components/schemas/monitorRunExecutionsData' runMonitor: title: Successful Response type: object properties: run: type: object description: Information about the monitor run. If you pass the `async=true` query parameter, the response does not return the `stats`, `executions`, and `failures` responses. To get this information for an asynchronous run, call the GET `/monitors/{id}` endpoint. properties: info: $ref: '#/components/schemas/monitorRunInfo' stats: $ref: '#/components/schemas/monitorRunStats' executions: $ref: '#/components/schemas/monitorRunExecutions' failures: type: array description: If the monitor run failed, information about the run's failures. items: type: object example: [] runMonitor202: title: Run Exceeds 300 Seconds type: object properties: run: type: object description: The response if the monitor's run exceeds 300 seconds. To get information about the monitor's run, call the GET `/monitors/{id}` endpoint. properties: info: type: object description: Information about the monitor. properties: monitorId: type: string description: The monitor's ID. example: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 status: type: string description: The monitor run's status. example: running message: type: string description: A message that details the monitor run's current status. example: The request is taking longer than expected, but is processing. To avoid this in future requests, pass the 'async=true' query parameter to use the async option. elementTypeQuery: type: string enum: - workspace example: workspace panElementName: type: string example: billing panSummary: type: string example: payments panElementDescription: type: string example: payments panAddedBy: type: integer example: 12345678 sortCreatedUpdatedAt: type: string enum: - createdAt - updatedAt example: updatedAt offset: type: integer default: 0 example: 5 limitDefault1000: type: integer default: 1000 example: 10 panParentFolderId: deprecated: true type: integer default: 0 example: 1 panMetadata: title: Metadata type: object description: The response's non-standard meta information. properties: limit: type: integer maximum: 1000 description: The maximum number of elements returned. If the value exceeds the maximum value of `1000`, then the system uses the `1000` value. example: 1000 offset: type: integer example: 0 description: The zero-based offset of the first item returned. totalCount: type: integer example: 2 description: The total number of elements. getPanElements: title: Successful Response type: object properties: elements: description: A list of Private API Network elements. type: array items: type: object description: Information about the Private API Network element. properties: createdAt: type: string format: date-time description: The date and time at which the element was created. example: '2024-11-29T06:31:24.000Z' createdBy: type: integer description: The user who created the element. example: 12345678 updatedAt: type: string format: date-time description: The date and time at which the element was last updated. example: '2024-11-29T06:31:24.000Z' updatedBy: type: integer description: The user ID of the user who updated the element. example: 12345678 addedAt: type: string format: date-time description: The date and time at which the element was published to your team's Private API Network. This value is the same as the `updatedAt` value. example: '2024-11-29T06:31:24.000Z' addedBy: type: integer description: The user ID of the user who published the element. example: 12345678 description: type: string nullable: true description: The element's description. example: null id: type: string description: The element's ID. example: 5360b75f-447e-467c-9299-12fd6c92450d name: type: string description: The element's name. example: Billing Team Workspace summary: type: string nullable: true description: The element's summary. example: The Billing team's workspace. type: type: string description: The `workspace` element type. example: workspace parentFolderId: deprecated: true type: integer description: The `0` value. example: 0 href: type: string format: url description: The element's HREF. example: https://api.postman.com/workspaces/1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 folders: deprecated: true type: array description: This property is deprecated and only returns an empty array. items: deprecated: true type: object additionalProperties: false meta: $ref: '#/components/schemas/panMetadata' panCreateWorkspace: title: Add Workspace type: object required: - workspace properties: workspace: type: object description: Information about the workspace to add to the Private API Network. required: - id properties: id: type: string description: The workspace's ID. example: 5360b75f-447e-467c-9299-12fd6c92450d parentFolderId: deprecated: true type: integer default: 0 description: The `0` value. example: 0 panElementCreated: title: Element Created description: Information about the Private API Network element. type: object properties: addedAt: type: string format: date-time description: The date and time at which the element was added. example: '2024-12-07T17:59:23.000Z' addedBy: type: integer description: The user who added the element. example: 12345678 createdBy: type: integer description: The user who created the element. example: 12345678 createdAt: type: string format: date-time description: The date and time at which the element was created. example: '2024-12-07T17:59:23.000Z' updatedBy: type: integer description: The user who last updated the element. example: 12345678 updatedAt: type: string format: date-time description: The date and time at which the element was last updated. example: '2024-12-07T17:59:23.000Z' type: type: string description: The `workspace` element. enum: - workspace example: workspace id: type: string description: The element's ID example: 5360b75f-447e-467c-9299-12fd6c92450d name: type: string description: The element's name. example: Billing Team Workspace summary: type: string nullable: true description: The element's summary. example: The Billing team's workspace. description: type: string nullable: true description: The element's description. example: null href: type: string format: url description: The element's Postman URL. example: https://api.postman.com/workspaces/1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 parentFolderId: deprecated: true type: integer nullable: true description: This property is deprecated. example: null panError: title: Error (Name, Message) type: object properties: name: type: string description: The error name. example: invalidParamsError message: type: string description: The error message. example: The specified request does not exist. updatePanWorkspace: title: Update Workspace deprecated: true type: object properties: workspace: type: object description: Information about the workspace fields to update. deprecated: true properties: parentFolderId: type: integer deprecated: true description: The workspace's new parent folder ID. example: 0 deletePanElement: title: Successful Response type: object properties: workspace: type: object description: The Private API Network `workspace` element type. properties: id: type: string description: The element's ID. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 panRequestedBy: type: integer example: 12345678 panRequestStatus: type: string enum: - pending - denied example: pending panRequestElement: type: object description: Information about the requested element. properties: id: type: string description: The element's ID. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 type: type: string description: The `workspace` element type. enum: - workspace example: workspace name: type: string description: The element's name. example: Billing Team Workspace summary: type: string nullable: true description: The element's short summary. example: The Billing team's workspace. description: type: string nullable: true description: The element's description. example: null panRequestResponse: description: Information about the response to the element's request. This object only returns when the request is denied with a message. type: object properties: createdAt: type: string format: date-time description: The date and time at which request was denied. example: '2024-06-01T08:32:31.000Z' createdBy: type: integer description: The ID of the user who denied the request. example: 12345678 message: type: string description: The request's response message. example: Too many errors, please fix and resubmit getAllPanAddElementRequests: title: Successful Response type: object properties: requests: description: A list of requests to add elements to the Private API Network. type: array items: type: object description: Information about the request. properties: id: type: integer description: The request's ID. example: 1 createdAt: type: string format: date-time description: The date and time at which the request was created. example: '2024-06-09T14:48:45.000Z' createdBy: type: integer description: The ID of the user who created the request. example: 12345678 message: type: string description: The user's optional message included in the request. example: Please approve this workspace status: type: string description: The request's status. enum: - pending - denied example: denied element: $ref: '#/components/schemas/panRequestElement' response: $ref: '#/components/schemas/panRequestResponse' meta: $ref: '#/components/schemas/panMetadata' panRequestId: type: integer example: 232 respondPanElementAddRequestBody: type: object required: - status properties: status: type: string description: The request's approval status. enum: - denied - approved example: denied response: type: object description: If the request is denied, the response to the user's request. properties: message: type: string description: A message that details why the user's request was denied. example: The requested collection has a lot of governance violations. Please fix them. respondPanElementAddRequestApprove: title: Request Approved type: object properties: request: type: array description: A list of Private API Network requests. items: type: object description: Information about the Private API Network request. properties: id: type: integer description: The request's ID. example: 2 createdAt: type: string format: date-time description: The date and time at which the request was created. example: '2024-06-09T14:48:45.000Z' createdBy: type: integer description: The ID of the user who created the request. example: 87654321 message: type: string description: The user's optional message included in the request. example: Please add this to the network status: type: string description: The request's status. enum: - approved - denied example: denied element: type: object description: Information about the requested element. properties: id: type: string description: The element's ID. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: type: string description: The element's name. example: Billing Team Workspace summary: type: string nullable: true description: The element's short summary. example: The Billing team's workspace. description: type: string nullable: true description: The element's description. example: The Billing team's workspace. type: type: string description: The `workspace` element type. enum: - workspace example: workspace createdBy: type: integer format: date-time description: The ID of the user who added the element to the Private API Network. example: 12345678 createdAt: type: string format: date-time description: The date and time the element was added to the Private API Network. example: '2024-06-09T14:48:45.000Z' respondPanElementAddRequestDeny: title: Request Denied type: object properties: request: type: array description: A list of Private API Network requests. items: type: object description: Information about the Private API Network request. properties: id: type: integer description: The request's ID. example: 2 createdAt: type: string format: date-time description: The date and time at which the request was created. example: '2022-06-09T14:48:45.000Z' createdBy: type: integer description: The ID of the user who created the request. example: 87654321 message: type: string description: The user's optional message included in the request. example: Please add this to the network status: type: string description: The request's status. enum: - approved - denied example: denied element: $ref: '#/components/schemas/panRequestElement' response: $ref: '#/components/schemas/panRequestResponse' generateOauthToken: type: object required: - grant_type - installationAuthId - jwt properties: grant_type: type: string description: The `client_credentials` OAuth grant type. example: client_credentials installationAuthId: type: string description: The client's installation authentication ID. example: e868878e40f646ce8b5620736995dc89 jwt: type: string description: A signed JWT token. The token must include `iss` (issuer), `aud` (audience), `iat` (issued at), `exp` (expiration timestamp), and `jti` (JWT ID). example: eyJhXXX generateOauthTokenResponse: type: object properties: access_token: type: string description: A Postman OAuth 2.0 access token. example: PMAK-XXX expires_in: type: integer description: The time the token expires, in milliseconds. example: 3600 token_type: type: string description: The `Bearer` token type. enum: - Bearer example: Bearer oauthTokenError: type: object properties: error: type: string description: The type of error. example: invalid_client error_description: type: string description: Information about the error. example: Token not found revokeOauthToken: type: object required: - token properties: token: type: string description: The Postman OAuth 2.0 access token to revoke. example: PMAK-XXX revokeOauthTokenResponse: type: object properties: success: type: string description: The `true` value. example: 'true' limitDefault100Max100: type: integer default: 100 minimum: 1 maximum: 100 example: 10 packageListData: type: object additionalProperties: false required: - id - name - description - createdAt - updatedAt properties: id: type: string description: The package's unique ID. example: 3b60f5f3-cd98-4e04-b560-3eb039fe85d8 name: type: string minLength: 1 maxLength: 200 pattern: ^[a-z][a-z0-9_-]*$ description: The package's immutable, lowercase import name. example: my-math-package description: type: string maxLength: 500 pattern: ^[ -~]*$ description: The package's description. example: This package contains utility functions to do math. createdAt: type: string format: date-time description: The date and time at which the package was created. example: '2026-08-01T20:11:17.000Z' updatedAt: type: string format: date-time description: The date and time at which the package was last updated. example: '2026-08-01T20:11:17.000Z' getPackages: type: object additionalProperties: false required: - meta - data properties: meta: $ref: '#/components/schemas/meta' data: description: A list of active packages. type: array items: $ref: '#/components/schemas/packageListData' createPackage: type: object additionalProperties: false required: - name properties: name: type: string minLength: 1 maxLength: 200 pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$ description: The package's import name. The service stores this value in lowercase. example: my-math-package description: type: string maxLength: 500 pattern: ^[ -~]*$ default: '' description: The package's description. This value may be empty and only supports printable ASCII characters. example: A package that provides math functions. script: type: string maxLength: 512000 default: '' description: The package's initial index script content. This value may be empty. example: 'module.exports = { add: (a, b) => a + b };' packageData: type: object additionalProperties: false description: Information about the package. required: - id - name - description - script - createdBy - createdAt - updatedAt properties: id: type: string description: The package's ID. example: 3b60f5f3-cd98-4e04-b560-3eb039fe85d8 name: type: string minLength: 1 maxLength: 200 pattern: ^[a-z][a-z0-9_-]*$ description: The package's immutable, lowercase import name. example: my-math-package description: type: string maxLength: 500 pattern: ^[ -~]*$ description: The package's description. This value may be empty and only supports printable ASCII characters. example: This package contains utility functions to do math. script: type: string maxLength: 512000 description: The package's current index script content. This value may be empty. example: 'module.exports = { add: (a, b) => a + b };' createdBy: type: integer minimum: 1 description: The user ID of the user who created the package. example: 123456 createdAt: type: string format: date-time description: The date and time at which the package was created. example: '2026-08-01T20:11:17.000Z' updatedAt: type: string format: date-time description: The date and time at which the package or its script was last updated. example: '2026-08-01T20:11:17.000Z' createPackageResponse: title: Unified Package description: Information about the created package and its index script content. allOf: - $ref: '#/components/schemas/packageData' packageId: type: string example: 3b60f5f3-cd98-4e04-b560-3eb039fe85d8 unifiedPackageResponse: type: object title: Unified Package description: Information about the created package and its index script content. properties: data: $ref: '#/components/schemas/packageData' getPackage: allOf: - $ref: '#/components/schemas/unifiedPackageResponse' updatePackage: type: object additionalProperties: false minProperties: 1 properties: description: type: string maxLength: 500 pattern: ^[ -~]*$ description: The package's description. This value may be empty and only supports printable ASCII characters. example: A package that provides math functions. script: type: string maxLength: 512000 description: The package's index script content. This value may be empty. example: 'module.exports = { add: (a, b) => a + b };' updatePackageResponse: allOf: - $ref: '#/components/schemas/packageData' generateTool: title: Generate Tool type: object required: - collectionId - requestId - config properties: requestId: type: string description: The public collection's request ID. example: c82dd02c-4870-4907-8fcb-593a876cf05b collectionId: type: string format: uid description: The Public API Network collection's ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 config: type: object required: - language - agentFramework description: Information about the request. properties: language: type: string description: The programming language to use. enum: - javascript - typescript - python example: javascript agentFramework: type: string description: The AI agent framework to use. Note that the `autogen` framework only supports the `python` language. enum: - openai - mistral - gemini - anthropic - langchain - autogen generateToolResponse: title: Generate Tool Response type: object properties: data: type: object description: The generated response data. properties: text: type: string description: The generated tool code. example: |- /** * Function to list all tax IDs for a specified customer in Stripe. * * @param {Object} args - Arguments for the request. * @param {string} args.customer - The ID of the customer whose tax IDs are to be retrieved. * @param {string} [args.ending_before] - A cursor for pagination, to fetch previous pages. * @param {string} [args.expand] - Specifies which fields in the response should be expanded. * @param {number} [args.limit] - A limit on the number of objects to be returned (1-100). * @param {string} [args.starting_after] - A cursor for pagination, to fetch next pages. * @returns {Promise} - The response containing the list of tax IDs. */ const executeFunction = async ({ customer, ending_before, expand, limit, starting_after }) => { const baseUrl = 'https://api.stripe.com'; const token = ''; // will be provided by the user try { // Construct the URL with path and query parameters const url = new URL(`${baseUrl}/v1/customers/${customer}/tax_ids`); if (ending_before) url.searchParams.append('ending_before', ending_before); if (expand) url.searchParams.append('expand[]', expand); if (limit) url.searchParams.append('limit', limit.toString()); if (starting_after) url.searchParams.append('starting_after', starting_after); // Set up headers for the request const headers = { 'Authorization': `Bearer ${token}`, 'Content-Type': 'application/x-www-form-urlencoded' }; // Perform the fetch request const response = await fetch(url.toString(), { method: 'GET', headers }); // Check if the response was successful if (!response.ok) { const errorData = await response.json(); throw new Error(errorData); } // Parse and return the response data const data = await response.json(); return data; } catch (error) { console.error('Error listing tax IDs:', error); return { error: 'An error occurred while listing tax IDs.' }; } }; /** * Tool configuration for listing tax IDs for a customer in Stripe. * @type {Object} */ const apiTool = { type: 'function', function: { name: 'list_tax_ids', function: executeFunction, description: 'List all tax IDs for a specified customer in Stripe.', parse: JSON.parse, parameters: { type: 'object', properties: { customer: { type: 'string', description: 'The ID of the customer whose tax IDs are to be retrieved.' }, ending_before: { type: 'string', description: 'A cursor for pagination, to fetch previous pages.' }, expand: { type: 'string', description: 'Specifies which fields in the response should be expanded.' }, limit: { type: 'integer', description: 'A limit on the number of objects to be returned (1-100).' }, starting_after: { type: 'string', description: 'A cursor for pagination, to fetch next pages.' } }, required: ['customer'], additionalProperties: false } } }; export const client = apiTool; postbot400Error: title: Bad Request type: object properties: detail: type: string description: Details about the occurrence of the error. example: \"body.config.agentFramework\" must be one of [openai, mistral, gemini, anthropic, langchain, autogen] status: type: number format: http-status-code description: The error's HTTP status code. example: 400 title: type: string description: A short summary of the error. example: Bad Request type: type: string format: uri description: The error type. example: https://api.postman.com/problems/bad-request pullRequestId: type: string example: 4e1a6609-1a29-4037-a411-89ecc14c6cd8 pullRequestSourceData: type: object description: Information about the pull request's source (parent) element. properties: id: type: string description: The pull request's source ID. example: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef name: type: string description: The source element's name. example: test-collection forkName: type: string description: The name of the fork created from the source element. example: Taylor Lee's fork exists: type: boolean description: If true, whether the element is present and not deleted. example: true pullRequestDestinationData: description: Information about the pull request destination element. type: object properties: id: type: string description: The destination element's ID. example: 123456789-24f57217-1169-4b7c-a810-0e957c04eaa5 name: type: string description: The destination element's name. example: test-collection exists: type: boolean description: If true, whether the element is present and not deleted. example: true pullRequestMergeData: type: object description: Information about the current progress of the pull request's merge. properties: status: type: string description: | The pull request's current merge status: - `inactive` — There is no merge in progress. - `inprogress` — The pull request is currently merging. - `failed` — The pull request's merge failed. enum: - inactive - inprogress - failed example: inactive pullRequestReviewersData: type: object properties: id: type: string description: The reviewer's user ID. example: '12345678' status: type: string description: The reviewer's review status response. enum: - approved - declined example: declined pullRequestGet: title: Successful Response type: object properties: createdAt: type: string description: The date and time at which the pull request was created. example: '2024-02-20T09:55:46.000Z' updatedAt: type: string description: The date and time at which the pull request was updated. example: '2024-02-20T09:58:38.000Z' id: type: string description: The pull request's ID. example: 4e1a6609-1a29-4037-a411-89ecc14c6cd8 title: type: string description: The pull request's title. example: Test PR description: type: string description: The pull request's description. example: This is a test pull request. createdBy: type: string description: The ID of the user who created the pull request. example: '12345678' updatedBy: type: string description: The ID of the user who last updated the pull request. example: '12345678' comment: type: string description: If the pull request is a `decline` status, an optional comment about why the pull request was declined. example: Missing descriptions in requests fortkType: type: string description: The type of element the pull request was forked from. example: collection source: $ref: '#/components/schemas/pullRequestSourceData' destination: $ref: '#/components/schemas/pullRequestDestinationData' status: type: string description: | The pull request's current review status: - `open` — The pull request is still open. - `approved` — The pull request was approved by its reviewers. - `declined` — The pull request was not approved by its reviewers. example: declined merge: $ref: '#/components/schemas/pullRequestMergeData' reviewers: type: array description: Information about the reviewers assigned to the pull request. items: $ref: '#/components/schemas/pullRequestReviewersData' pullRequestUpdate: title: Update Pull Request type: object required: - reviewers - title properties: title: type: string description: The pull request's updated title. example: Updated PR title description: type: string description: The updated pull request description. example: Updated description of the pull request. reviewers: type: array description: 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. items: type: string description: The reviewer's user ID. example: '12345678' pullRequestUpdated: title: Pull Request Updated type: object properties: createdAt: type: string format: date-time description: The date and time at which the pull request was created. example: '2024-02-20T09:58:57.000Z' createdBy: type: string description: The ID of the user who created the pull request. example: '12345678' description: type: string description: The pull request's description. example: Updated description of the pull request. destinationId: type: string format: uid description: The pull request's merge destination ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 forkType: type: string description: The type of forked element. example: collection id: type: string description: The pull request's ID. example: 4e1a6609-1a29-4037-a411-89ecc14c6cd8 sourceId: type: string format: uid description: The unique ID of the source element. example: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef status: type: string description: The pull request's status. enum: - open - approved - declined - merged example: open title: type: string description: The pull request's title. example: Updated PR title updatedAt: type: string format: date-time description: The date and time at which the pull request was updated. example: '2024-02-20T09:58:57.000Z' pullRequestReview: title: Review Pull Request type: object required: - action properties: action: type: string description: | The action to perform on the pull request: - `approve` — Approve the pull request for merge. - `decline` — Decline the pull request. - `merge` — Merge the pull request into its parent element. - `unapprove` — Revokes a pull request's `approve` status. This action does not decline the pull request. enum: - approve - decline - merge - unapprove example: decline comment: type: string description: If the pull request is a `decline` status, an optoinal comment about why the pull request was declined. example: Missing descriptions in requests pullRequestReviewedByData: type: object description: Information about the user who reviewed the pull request review. properties: id: type: number description: The user's ID. example: 12345678 name: type: string description: The user's name. example: Taylor Lee username: type: string description: The user's username. example: taylor-lee pullRequestReviewReponse: title: Successful Response type: object properties: id: type: string description: The pull request's ID. example: 4e1a6609-1a29-4037-a411-89ecc14c6cd8 reviewedBy: $ref: '#/components/schemas/pullRequestReviewedByData' status: type: string description: | The pull request's current review status: - `open` — The pull request is still open. - `approved` — The pull request was approved by its reviewers. - `declined` — The pull request was not approved by its reviewers. - `merged` — The pull request was merged. example: approved updatedAt: type: string description: The date and time at which the pull request was updated. example: '2024-02-21T08:19:09.000Z' runnerId: type: string example: 1f08d6ba-c377-4ca0-be80-af81daf8fef9 runnerMeta: type: object description: The response's meta information for paginated results. properties: model: type: string description: The `runnerInstance` value. example: runnerInstance action: type: string description: The `find` value. example: find url: type: string format: uri-reference description: The reference URL to the resource. example: https://testing.example.com/runners/1f08d6ba-c377-4ca0-be80-af81daf8fef9/instances?limit=1 nextCursor: type: string description: The pagination cursor that points to the next record in the results set. example: 2NMbfiEAxQcpbmTFnmfQw7jV83WCRxjFxCwipofDVfn83ac16idLnRngzvpj4VNR5GsufwXVFrWX59iLNdV7CEriGGCutycbRD1smGoWV9F5GMLGs59mGQX5hnmnhsvxDLYt1kaJgkZYk6fs9oxoaqLvLbRSQb4LyBn4vkTh1T6Xvt1c8Pe9SPR2xJ5y3fPe6judViwg1CPLJbDdRNFZ6GJ8qDp26hJE8ZPTwoYrj runnerInstance: title: Runner Instance Data type: object description: Information about the runner instance. properties: id: type: string description: The runner instance's ID. example: Rtesting-78b4f9c59c-5c7mx|b5862804ba|1.23.0|Linux hostname: type: string description: The hostname of the machine where the runner instance is running. example: testing-78b4f9c59c-5c7mx uniqueId: type: string description: The runner instance's unique ID. example: b5862804ba cliVersion: type: string description: The version of the [Postman CLI](https://learning.postman.com/docs/postman-cli/postman-cli-overview/) used to start the runner instance. example: 1.23.0 osType: type: string description: The operating system of the machine where the runner instance is running. example: Linux runnerId: type: string description: The runner's ID. example: 1f08d6ba-c377-4ca0-be80-af81daf8fef9 lastPingedAt: type: string format: date-time description: The last date and time the runner instance sent results to the Postman cloud. example: '2025-11-06T14:59:53.000Z' getRunnerInstances: type: object properties: meta: $ref: '#/components/schemas/runnerMeta' data: type: array description: A list of all runner instances. items: $ref: '#/components/schemas/runnerInstance' runnerErrorTypeTitleDetailCreatedAt: title: Error (Type, Title, Detail, CreatedAt) type: object properties: type: type: string format: uri-reference description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem. example: urn:error:monitor:instanceNotFoundError title: type: string description: A short summary of the problem. example: Instance not found in the database. detail: type: string description: Information about the error. example: Runner not found. createdAt: type: string description: The date and time at which the error occurred. example: '2025-11-06T14:14:45.934Z' getRunnerMetrics: type: object description: The runner instance's metrics information. properties: lastPingAt: type: string description: The last date and time the runner sent results to the Postman cloud. example: '2025-09-21T12:11:19.000Z' oldestQueuedRunAgeSeconds: type: integer description: The age of the monitor, in seconds, that has been waiting the longest to run in the runner. example: 10213 queueDepth: type: integer description: The number of pending Postman monitor runs in the runner's queue. example: 9 rulesetSummary: type: object description: Information about a ruleset, without its content. properties: id: type: string description: The ruleset's ID. example: 01JABCDEF0123456789ABCDEFG name: type: string description: The ruleset's name. example: api-style-guide description: type: string description: The ruleset's description. example: Company-wide rules for API specifications. engine: type: string description: The governance engine the ruleset targets. enum: - spectral example: spectral format: type: string description: The resource the ruleset governs. enum: - spectral - workspace example: spectral type: type: string description: | The ruleset's type: - `system` — Rulesets managed by Postman (for example, the Postman standard and OWASP rulesets that ship with governance) and can't be updated or deleted. - `custom` — Rulesets created and managed by your team. enum: - system - custom example: custom createdBy: type: string description: The ID of the user who created the ruleset. example: '12345678' updatedBy: type: string description: The ID of the user who last updated the ruleset. example: '12345678' createdAt: type: string format: date-time description: The date and time at which the ruleset was created. example: '2026-07-13T10:15:30.000Z' updatedAt: type: string format: date-time description: The date and time at which the ruleset was last updated. example: '2026-07-13T11:20:00.000Z' rulesetList: type: object description: A paginated list of ruleset summaries. properties: data: type: array description: A list of rulesets. items: $ref: '#/components/schemas/rulesetSummary' meta: $ref: '#/components/schemas/meta' rulesetCreate: type: object description: Information about the ruleset. required: - name - description - engine - format - content properties: name: type: string maxLength: 255 description: The ruleset's name. Must be unique within the team and only contain letters, numbers, hyphens, underscores, and periods. pattern: ^[a-zA-Z0-9_.-]+$ example: api-style-guide description: type: string maxLength: 1000 description: The ruleset's description. example: Company-wide rules for API specifications. engine: type: string description: The governance engine that runs the ruleset. enum: - spectral example: spectral format: type: string description: The type of resource the ruleset governs. enum: - spectral - workspace example: spectral content: type: string description: The ruleset's content, up to a maximum of 500 KB (UTF-8). example: |- formats: - oas2 - oas3 - aas2 - aas3 rules: operation-operationId: true rulesetId: type: string example: 01JABCDEF0123456789ABCDEFG ruleset: description: Information about the ruleset. The `content` field is only present when the request includes the `include=content` query parameter on the get-by-ID endpoint. allOf: - $ref: '#/components/schemas/rulesetSummary' - type: object properties: content: type: string description: The ruleset's content, up to a maximum of 500 KB (UTF-8). example: |- formats: - oas2 - oas3 - aas2 - aas3 rules: operation-operationId: true rulesetUpdate: type: object minProperties: 1 additionalProperties: false description: The fields to update on a ruleset. properties: name: type: string maxLength: 255 pattern: ^[a-zA-Z0-9_.-]+$ description: The ruleset's name. example: API_Style_Guide_v2 description: type: string maxLength: 1000 description: The ruleset's description. example: Updated company-wide rules for API specifications. content: type: string description: The ruleset's content, up to a maximum of 500 KB (UTF-8). example: |- rules: operation-operationId: true rulesetAssignmentCreate: type: object description: Information about the ruleset assignment. required: - targetType - targetId properties: targetType: type: string description: The assignment target type. enum: - governance_group example: governance_group targetId: type: string description: The target governance group's ID. example: 01JWSGROUP0123456789ABCDEF targetType: type: string enum: - governance_group example: governance_group secretTypeData: type: object description: Information about the secret type. properties: name: type: string description: The name of the secret type. example: Postman Collection Key id: type: string description: The ID of the secret type. example: 04084949-0dda-4735-ace5-f83038f7b200 type: type: string description: | The origin of the secret type: - `DEFAULT` — Supported by default in Postman. - `TEAM_REGEX` — A custom regex added by an Admin or Super Admin user in the **Configure Alerts** section of the [**Team Settings**](https://learning.postman.com/docs/administration/team-settings/) interface. enum: - DEFAULT - TEAM_REGEX example: TEAM_REGEX secretScannerMetaTotalSecretsData: type: object description: Aggregate counts across the returned records. properties: total: type: integer description: The total number of supported secrets. example: 4 getSecretTypes: title: Successful Response type: object properties: data: type: array description: A list of secret types the scanner can detect. items: $ref: '#/components/schemas/secretTypeData' meta: $ref: '#/components/schemas/secretScannerMetaTotalSecretsData' schemaSecurityValidationRequest: title: Schema Validation Request Body type: object properties: schema: type: object description: The API definition to validate. required: - language - schema - type properties: language: type: string description: The definition format. enum: - json - yaml example: json schema: type: string description: The stringified API definition. example: '{"openapi":"3.0.0","info":{"version":"1","title":"temp","license":{"name":"MIT"}},"servers":[{"url":"https://petstore.swagger.io/v1"}],"paths":{"/user":{"get":{"summary":"Details about a user","operationId":"listUser","tags":["user"],"parameters":[{"name":"id","in":"query","description":"ID of the user","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Details about a user","headers":{"x-next":{"description":"A link to the next page of responses","schema":{"type":"string"}}},"content":{"application/json":{"schema":{$ref:"#/components/schemas/User"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{$ref:"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"User":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"tag":{"type":"string"}}},"Error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"}}}},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"security":[{"BasicAuth":[]}]}' type: type: string description: The definition type. enum: - openapi3 - openapi2 example: openapi3 schemaSecurityValidationResponse: title: Successful Response type: object properties: warnings: type: array description: | Information about each issue discovered in the analysis. Each object includes the violation's severity and category, the location of the issue, data paths, and other information. This returns an empty object if there are no issues present in the schema. If there are issues, this returns the `possibleFixUrl` response in each warning object. This provides a link to documentation you can use to resolve the warning. items: type: object additionalProperties: true commonErrorNameObjectNameMessage: title: Error (Name, Message) type: object properties: error: type: object description: Information about the error. properties: name: type: object description: Information about the error. properties: name: type: string description: The error name. example: paramMissingError message: type: string description: The error message. example: Parameter is missing in the request. tagsSlug: type: string pattern: ^[a-z][a-z0-9-]*[a-z0-9]+$ maxLength: 64 minLength: 2 example: needs-review tagsEntitiesLimit: type: integer default: 10 maximum: 50 example: 2 tagsCursor: type: string format: base64 example: eyJpZCI6ODYsImVudGl0eVR5cGUiOiJhcGkifQ== tagsEntityType: type: string enum: - api - collection - workspace example: collection getTaggedEntities: title: Successful Response type: object properties: data: type: object description: An object containing the paginated elements. required: - entities properties: entities: type: array description: A list of the Postman elements that contain the given tag. items: type: object properties: entityId: type: string format: uid description: The element's unique ID. example: 12345678-6fd634a3-79ba-451d-8f07-56a953f96667 entityType: enum: - collection - workspace type: string description: The type of Postman element. example: collection meta: type: object description: The response's pagination information. required: - count properties: count: type: integer description: The number of tagged elements returned in the response. example: 2 nextCursor: type: string format: base64 description: The pagination cursor that points to the next record in the results set. example: eyJpZCI6ODYsImVudGl0eVR5cGUiOiJhcGkifQ== startIndex: type: number minimum: 1 default: 1 example: 1 count: type: number default: 100 example: 2 scimGroupFilter: type: string example: displayName eq "TestAPI" schemaUriArray: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:schemas:core:2.0:ResourceType scimGroupsMembersList: type: array description: A list of the group's members. items: type: object description: Information about the group's members. properties: value: type: string description: The user's SCIM ID. example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 display: type: string description: The user's display name. example: Taylor Lee scimMetaDataResourceTypeCreatedLastModified: type: object description: The response's non-standard meta information. properties: resourceType: type: string description: The resource type. enum: - User - Group example: User created: type: string format: date-time description: The date and time at which the team member was created. example: '2021-02-22T04:24:13.000Z' lastModified: type: string format: date-time description: The date and time at which the team member was last modified. example: '2021-02-22T04:24:13.000Z' scimGroupResource: title: SCIM Group Resource description: The SCIM group resource object. type: object properties: schemas: $ref: '#/components/schemas/schemaUriArray' id: type: string description: The group's SCIM ID. example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 displayName: type: string description: The group's display name. example: Test SCIMv2 members: $ref: '#/components/schemas/scimGroupsMembersList' externalId: type: string description: The group's external ID. example: '1234' meta: $ref: '#/components/schemas/scimMetaDataResourceTypeCreatedLastModified' getScimGroupResources: title: Successful Response type: object properties: Resources: type: array description: A list of group resources. items: $ref: '#/components/schemas/scimGroupResource' itemsPerPage: type: number description: The number of items per response page. example: 2 schemas: $ref: '#/components/schemas/schemaUriArray' startIndex: type: number description: The index entry by which the returned results begin. example: 1 totalResults: type: number description: The total number of results found. example: 2 scimError: title: SCIM Error (Schemas, Detail, Status) type: object properties: schemas: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:api:messages:2.0:Error detail: type: string description: Information about the error. example: This Postman team doesn't exist anymore. status: type: string format: http-status-code description: The HTTP status code. example: '400' createScimGroup: title: Create SCIM Group type: object properties: schemas: $ref: '#/components/schemas/schemaUriArray' displayName: type: string description: The group's display name. example: Test-API members: $ref: '#/components/schemas/scimGroupsMembersList' createScimGroupResponse: title: SCIM Group Created type: object properties: schemas: $ref: '#/components/schemas/schemaUriArray' id: type: string description: The group's SCIM ID. example: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00 displayName: type: string description: The group's display name. example: Test-API externalId: type: string description: The group's external ID. example: '1234' members: $ref: '#/components/schemas/scimGroupsMembersList' meta: $ref: '#/components/schemas/scimMetaDataResourceTypeCreatedLastModified' scimErrorScimType: title: SCIM Error (Schemas, SCIM Type, Detail, Status) type: object properties: schemas: type: array description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). items: type: string example: urn:ietf:params:scim:api:messages:2.0:Error scimType: type: string description: The SCIM error type. example: invalidSyntax detail: type: string description: Information about the error. example: The request body seems to be incomplete or have unsupported characters. status: type: string format: http-status-code description: The HTTP status code. example: '400' scimId: type: string example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 getScimGroupResource: title: Successful Response type: object properties: schemas: $ref: '#/components/schemas/schemaUriArray' id: type: string description: The group's SCIM ID. example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 displayName: type: string description: The group's display name. example: Test-API members: $ref: '#/components/schemas/scimGroupsMembersList' externalId: type: string description: The group's external ID. example: '1234' meta: $ref: '#/components/schemas/scimMetaDataResourceTypeCreatedLastModified' scimOperationsGroupsList: type: array description: Information about the group update operation. items: type: object properties: op: type: string description: The operation to perform. enum: - replace - remove - add example: replace path: type: string description: The operation's path. Include this value when you update a group's members. example: members value: type: object description: The performed operation's value. properties: id: type: string description: The group's ID. example: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00 displayName: type: string description: The group's name. example: Test-API scimUpdateGroup: title: Update SCIM Group type: object properties: schemas: $ref: '#/components/schemas/schemaUriArray' Operations: $ref: '#/components/schemas/scimOperationsGroupsList' scimUpdateGroupResponse: title: SCIM Group Updated type: object properties: schemas: $ref: '#/components/schemas/schemaUriArray' id: type: string description: The group's ID. example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 displayName: type: string description: The group's name. example: Test-API members: description: A list of the group's members. allOf: - $ref: '#/components/schemas/scimGroupsMembersList' nullable: true externalId: type: string description: The group's external ID. example: '1234' meta: $ref: '#/components/schemas/scimMetaDataResourceTypeCreatedLastModified' schemaExtensionsData: type: object properties: schema: type: string description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). example: urn:ietf:params:scim:schemas:extension:enterprise:2.0:User required: type: boolean description: If true, the resource must include this schema extension. example: true schemaExtensionsList: type: array description: Information about the resource's schema extensions. items: $ref: '#/components/schemas/schemaExtensionsData' getScimResourceTypes: title: Successful Response type: array items: type: object properties: schemas: $ref: '#/components/schemas/schemaUriArray' id: type: string description: The resource's ID. example: User name: type: string description: The resource's friendly name. example: User endpoint: type: string description: The resource's endpoint. example: /Users description: type: string description: The resource's description. example: User Account schema: type: string description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml). example: urn:ietf:params:scim:schemas:core:2.0:User schemaExtensions: $ref: '#/components/schemas/schemaExtensionsList' scimSupported: type: boolean description: If true, the feature is supported. example: true patchConfigData: type: object description: Information about patch configuration. properties: supported: $ref: '#/components/schemas/scimSupported' bulkConfigData: type: object description: Information about bulk configuration. properties: maxOperations: type: number description: The total number of maximum operations allowed for bulk operations. example: 0 maxPayloadSize: type: number description: The maximum payload allowed for bulk operations. example: 0 supported: $ref: '#/components/schemas/scimSupported' filterConfigData: type: object description: Information about the filter configuration. properties: maxResults: type: number description: The total number of maximum results allowed for filter operations. example: 100 supported: $ref: '#/components/schemas/scimSupported' changePasswordConfigData: type: object description: Information about the change password configuration. properties: supported: $ref: '#/components/schemas/scimSupported' sortConfigData: type: object description: Information about the sort configuration. properties: supported: $ref: '#/components/schemas/scimSupported' authenticationSchemesData: type: object description: Information about the scheme. properties: description: type: string description: The scheme's description. example: Authentication scheme using the OAuth Bearer Token Standard name: type: string description: The scheme's friendly name. example: OAuth Bearer Token specUri: type: string format: url description: A link to the scheme's specification documentation. example: http://www.rfc-editor.org/info/rfc6750 type: type: string description: The scheme's type. example: oauthbearertoken authenticationSchemesList: type: array description: A list of authentication schemes. items: $ref: '#/components/schemas/authenticationSchemesData' entityTagData: type: object description: Information about the [entity tag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) (Etag) HTTP response header configuration. properties: supported: $ref: '#/components/schemas/scimSupported' scimMetaData: type: object description: The response's non-standard meta information. properties: resourceType: type: string description: The type of resource. example: ServiceProviderConfig location: type: string description: The location of the resource. format: url example: https://api.postman.com/scim/v2/ServiceProviderConfig getScimServiceProviderConfig: title: Successful Response type: object description: Information about Postman's SCIM API configurations and supported operations. properties: schemas: $ref: '#/components/schemas/schemaUriArray' documentationUri: type: string format: url description: A link to the URI's documentation. example: https://learning.postman.com/docs/administration/managing-your-team/configuring-scim patch: $ref: '#/components/schemas/patchConfigData' bulk: $ref: '#/components/schemas/bulkConfigData' filter: $ref: '#/components/schemas/filterConfigData' changePassword: $ref: '#/components/schemas/changePasswordConfigData' sort: $ref: '#/components/schemas/sortConfigData' authenticationSchemes: $ref: '#/components/schemas/authenticationSchemesList' etag: $ref: '#/components/schemas/entityTagData' meta: $ref: '#/components/schemas/scimMetaData' scimUserFilter: type: string example: userName eq "taylor-lee%40example.com" scimNameData: type: object description: Information about the Postman team member. properties: givenName: type: string description: The team member's first name. example: Taylor familyName: type: string description: The team member's last name. example: Lee scimUserResource: title: SCIM User Resource description: The SCIM user resource object. type: object properties: schemas: $ref: '#/components/schemas/schemaUriArray' id: type: string description: The team member's SCIM ID. example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 userName: type: string description: The team member's SCIM username. example: taylor.lee@example.com name: $ref: '#/components/schemas/scimNameData' externalId: type: string description: The team member's external ID. example: '12345678' active: type: boolean description: If true, the team member is active. example: true meta: $ref: '#/components/schemas/scimMetaDataResourceTypeCreatedLastModified' scimUserResources: title: SCIM Users type: object properties: Resources: type: array description: A list of user resources. items: $ref: '#/components/schemas/scimUserResource' itemsPerPage: type: number description: The number of items per response page. example: 2 schemas: $ref: '#/components/schemas/schemaUriArray' startIndex: type: number description: The index entry by which the returned results begin. example: 1 totalResults: type: number description: The total number of results found. example: 1000 activeData: type: boolean description: | Sets the user's `active` state: - `true` — Activates the user. This lets them authenticate in to your Postman team. - `false` — Removes the user from your Postman team and deactivates the account. This blocks the user from authenticating in to Postman. example: true createScimUser: title: Create SCIM User type: object properties: schemas: $ref: '#/components/schemas/schemaUriArray' userName: type: string description: The user's username. example: taylor.lee@example.com active: $ref: '#/components/schemas/activeData' externalId: type: string description: The user's external ID. example: '12345678' groups: type: array description: A list of groups to assign the user to. items: type: string example: Test Group locale: type: string description: The user's [IETF language tag](https://datatracker.ietf.org/doc/html/rfc5646). example: en-US name: $ref: '#/components/schemas/scimNameData' scimEmailData: type: object description: Information about the email address. properties: primary: type: boolean description: If true, the email address is the user's primary email. example: true value: type: string format: email description: The email address. example: taylor.lee@example.com type: type: string description: The type of email address. example: work display: type: string description: The email address's display name. example: taylor-lee@example.com scimEmailList: type: array description: A list of user email addresses. items: $ref: '#/components/schemas/scimEmailData' createScimUserResponse: title: SCIM User Created type: object properties: schemas: $ref: '#/components/schemas/schemaUriArray' id: type: string description: The user's SCIM ID. example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 userName: type: string format: email description: The user's username. example: taylor.lee@example.com name: $ref: '#/components/schemas/scimNameData' emails: $ref: '#/components/schemas/scimEmailList' externalId: type: string description: The user's external ID. example: '12345678' active: type: boolean description: If true, the user is active. example: true meta: $ref: '#/components/schemas/scimMetaDataResourceTypeCreatedLastModified' scimUserResourceResponse: title: SCIM User Resource type: object properties: schemas: $ref: '#/components/schemas/schemaUriArray' id: type: string description: The team member's SCIM ID. example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 userName: type: string description: The team member's SCIM username. example: taylor.lee@example.com name: $ref: '#/components/schemas/scimNameData' externalId: type: string description: The team member's external ID. example: '12345678' active: type: boolean description: If true, the team member is active. example: true meta: $ref: '#/components/schemas/scimMetaDataResourceTypeCreatedLastModified' updateScimUser: title: Update SCIM User type: object properties: schemas: $ref: '#/components/schemas/schemaUriArray' userName: type: string format: email description: The user's email address. example: taylor-lee@example.com name: $ref: '#/components/schemas/scimNameData' active: $ref: '#/components/schemas/activeData' scimOperationsUsersActiveList: type: array description: Information about the user update operation. items: type: object properties: op: type: string description: The operation to perform. enum: - replace example: replace value: type: object description: The performed operation's value. properties: active: $ref: '#/components/schemas/activeData' scimOperationsUsersUserNameList: type: array description: Information about the user update operation. items: type: object properties: op: type: string description: The operation to perform. Accepts the `replace` value. enum: - replace example: replace path: type: string description: The operation's path. Accepts the `userName` value. enum: - userName example: userName value: type: string format: email description: The user's email address. example: taylor.lee@example.com updateScimUserPatch: title: Update SCIM User anyOf: - title: Update Active State type: object properties: schemas: $ref: '#/components/schemas/schemaUriArray' Operations: $ref: '#/components/schemas/scimOperationsUsersActiveList' - title: Update Username type: object properties: schemas: $ref: '#/components/schemas/schemaUriArray' Operations: $ref: '#/components/schemas/scimOperationsUsersUserNameList' sdkId: type: string description: The SDK's ID. example: 9c4e7d1a-2b3c-4f5e-8a9b-1c2d3e4f5a6b sdkBuildStatus: type: string description: | The SDK's build lifecycle: - `queued` — Accepted but not yet started. - `in_progress` — The SDK generation is running and in progress. - `succeeded` — The archive is built and available for download. - `failed` — The SDK generation failed. For information, check the `error` response. enum: - queued - in_progress - succeeded - failed example: succeeded sdkLanguage: type: string description: The target output language for the generated SDK. enum: - typescript - python - go - java - csharp - ruby - php - kotlin - rust - cli example: typescript sdkSourceId: type: string example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 elementType-2: type: string description: The type of Postman element. enum: - collection - spec example: collection sdkSource: type: object description: The collection or specification that the SDK is generated from. required: - type - id properties: type: $ref: '#/components/schemas/elementType-2' id: type: string description: The ID of the Postman Collection or specification in Postman. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 sdkErrorBuildStatusFailure: type: object description: Information about the SDK build's status when `buildStatus` is `failed`. required: - code - message properties: code: type: string description: The build failure's error code. example: spec_validation_failed message: type: string description: Information about the build failure. example: 'OpenAPI spec failed validation: missing operationId on GET /foo' sdkGitConnectionPRStatus: type: string description: The lifecycle status of a pull request. enum: - open - merged - closed example: merged simpleSdkGitConnectionPullRequest: type: object required: - url - status - sdkId properties: url: type: string format: uri description: The pull request's URL. example: https://git.example.com/engineering/engineering-sdk/pull/87 status: $ref: '#/components/schemas/sdkGitConnectionPRStatus' sdkId: $ref: '#/components/schemas/sdkId' sdkPullRequest: type: object description: If the SDK was shipped (or proposed for shipping) through a Git connection, this is a compact representation of the pull request that shipped it. Otherwise, this returns a `null` value. nullable: true allOf: - $ref: '#/components/schemas/simpleSdkGitConnectionPullRequest' sdk: type: object description: Information about the generated SDK. required: - id - language - source - workspaceId - buildStatus - createdAt - updatedAt properties: id: $ref: '#/components/schemas/sdkId' language: $ref: '#/components/schemas/sdkLanguage' source: $ref: '#/components/schemas/sdkSource' workspaceId: type: string description: The ID of the workspace that owns the SDK, derived from the source entity. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 version: type: string description: The generated SDK's semantic version ID. This value is automatically assigned by the release/changelog pipeline. example: 1.0.0 buildStatus: $ref: '#/components/schemas/sdkBuildStatus' error: $ref: '#/components/schemas/sdkErrorBuildStatusFailure' pullRequest: $ref: '#/components/schemas/sdkPullRequest' createdAt: type: string format: date-time description: The date and time at which the SDK was created. example: '2026-05-30T10:21:14Z' updatedAt: type: string format: date-time description: The date and time at which the SDK was last updated. example: '2026-05-30T10:21:14Z' metaNextCursorTotal: type: object description: The response's meta information for paginated results. properties: nextCursor: type: string nullable: true description: The pagination cursor that points to the next record in the results set. example: bmV4dDppZDpZWEpqYUdsMllXeEVRaXhtWldWa2MxOHlNREkxWHpFc01UTXpNelE0 total: type: integer minimum: 0 description: The number of records found. example: 1 sdkList: type: object required: - data - meta properties: data: type: array description: A list of SDKs. items: $ref: '#/components/schemas/sdk' meta: $ref: '#/components/schemas/metaNextCursorTotal' sdkError: type: object required: - type - title - status properties: type: type: string format: uri description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem. example: https://api.postman.com/problems/invalid-request title: type: string description: A short summary of the problem. example: Invalid request status: type: integer format: http-status-code description: The error's HTTP status code. example: 400 detail: type: string description: Information about the error. example: '`typescriptOptions.npmName` is not a valid npm package name.' instance: type: string description: A URI reference that identifies the specific occurrence of the problem. example: /sdks requestId: type: string description: The request's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 sdkAuthorData: type: object description: Information about the author of the generated SDK. required: - name properties: name: type: string description: The author's name. example: Engineering email: type: string format: email description: The author's email address. example: engineering@example.com httpCodesToRetry: type: integer description: An HTTP status code. minimum: 200 maximum: 599 example: 429 sdkRetryOptions: type: object description: Retry behavior baked into the generated SDK's HTTP client. A power-user option; sensible defaults apply for any field left unset. required: - retryDelay properties: enabled: type: boolean default: true description: If true, the generated SDK includes retry behavior. example: true maxAttempts: type: integer default: 3 description: The maximum number of attempts to try before giving up. example: 3 retryDelay: type: integer default: 150 description: The base wait between attempts, in milliseconds. example: 150 maxDelay: type: integer minimum: 0 description: The maximum wait between attempts, in milliseconds. example: 3000 backOffFactor: type: number exclusiveMinimum: true minimum: 0 description: The exponent base used to compute exponential backoff between attempts. example: 2 retryDelayJitter: type: integer minimum: 0 description: The maximum random jitter added to wait times, in milliseconds. example: 100 httpCodesToRetry: type: array description: A list of HTTP status codes that the SDK attempts its retries on. items: $ref: '#/components/schemas/httpCodesToRetry' httpMethodsToRetry: type: array description: A list of the HTTP methods that the SDK attempts its retries on. items: type: string enum: - GET - POST - PUT - DELETE - PATCH - HEAD - OPTIONS - CONNECT - TRACE example: GET typescriptOptions: type: object description: TypeScript-specific SDK generation options. properties: npmOrg: type: string description: An npm organization's scope. Don't include a trailing slash. example: '@engineering' npmName: type: string description: The unscoped npm package's name. example: engineering-sdk pythonOptions: type: object description: Python-specific SDK generation options. properties: pypiPackageName: type: string description: The PyPI package's name. example: engineering-sdk goOptions: type: object description: Go-specific SDK generation options. properties: goModuleName: type: string description: The Go module path written into the `go.mod` definition file. example: github.com/engineering/engineering-sdk javaOptions: type: object description: Java-specific SDK generation options. properties: groupId: type: string description: The Maven group ID written into the `pom.xml` dependencies file. example: com.engineering artifactId: type: string description: The Maven artifact ID written into the `pom.xml` dependencies file. example: engineering-sdk csharpOptions: type: object description: C#-specific SDK generation options. properties: packageId: type: string description: The NuGet package's ID. example: engineering.Sdk rubyOptions: type: object description: Ruby-specific generation options. properties: gemName: type: string description: The RubyGems gem's name. example: engineering-sdk phpOptions: type: object description: PHP-specific SDK generation options. properties: packageName: type: string description: The composer package name, in `vendor/package` format. example: engineering/sdk kotlinOptions: type: object description: Kotlin-specific SDK generation options. properties: groupId: type: string description: The Maven group ID written into the `pom.xml` dependencies file. example: com.engineering artifactId: type: string description: The Maven artifact ID written into the `pom.xml` dependencies file. example: engineering-sdk rustOptions: type: object description: Rust-specific SDK generation options. properties: packageName: type: string description: The crates.io package's name. example: engineering-sdk cliOptions: type: object description: CLI-specific SDK generation options. properties: goModuleName: type: string description: The Go module's path for the generated CLI. example: github.com/engineering/engineering-cli createSdk: type: object description: | **Note:** - Only the object passed in the request body that matches the value in the `language` property gets read, and all other objects are ignored. - The language option object is optional. When the language identifier is omitted, it's derived from the `source` element name and its workspace. required: - source - language properties: source: $ref: '#/components/schemas/sdkSource' language: $ref: '#/components/schemas/sdkLanguage' sdkVersion: type: string description: An optional override for the SDK version. If this isn't provided, the next version is resolved from the latest auto-pull request. example: 1.0.0 authors: type: array description: A list of package authors written into the generated manifest. items: $ref: '#/components/schemas/sdkAuthorData' retry: $ref: '#/components/schemas/sdkRetryOptions' typescriptOptions: $ref: '#/components/schemas/typescriptOptions' pythonOptions: $ref: '#/components/schemas/pythonOptions' goOptions: $ref: '#/components/schemas/goOptions' javaOptions: $ref: '#/components/schemas/javaOptions' csharpOptions: $ref: '#/components/schemas/csharpOptions' rubyOptions: $ref: '#/components/schemas/rubyOptions' phpOptions: $ref: '#/components/schemas/phpOptions' kotlinOptions: $ref: '#/components/schemas/kotlinOptions' rustOptions: $ref: '#/components/schemas/rustOptions' cliOptions: $ref: '#/components/schemas/cliOptions' sdkDownload: type: object required: - id - language - url - expiresAt properties: id: $ref: '#/components/schemas/sdkId' language: $ref: '#/components/schemas/sdkLanguage' url: type: string format: uri description: A short-lived signed URL to the generated SDK archive (zip). example: https://sdk-gen-artifacts.s3.amazonaws.com/...signed... expiresAt: type: string format: date-time description: The date and time at which the signed URL expires. example: '2026-05-30T10:21:14Z' sdkGitConnectionStatus: type: string description: | The lifecycle status of the Git connection: - `active` — The connection is live and all opened pull requests ship SDK updates into the repository. - `disconnected` — The connection was explicitly disconnected by the owner, and no pull requests can be opened. The historical record is preserved. - `inaccessible` — Access to the repository was revoked or its no longer reachable. enum: - active - disconnected - inaccessible example: active sdkGitConnectionRepositoryUrl: type: string format: uri description: Filter results by the canonical URL of the target Git repository. example: https://git.example.com/engineering/engineering-sdk sdkGitConnectionId: type: string description: The Git connection's ID. example: 8d4f7c1a-2b3e-4f5a-9c8d-1a2b3c4d5e6f autoUpdatePullRequestsEnabled: type: boolean description: | If true, pull requests are opened automatically whenever the source changes or a new version of the SDK generator is released. If false, pull requests are opened automatically, but only for manually-triggered SDK regeneration. If `autoUpdatePullRequestsEnabled` isn't set, the default behavior depends on the user's Postman plan: - **Enterprise** plan users — Defaults to the `true` value. - **Team** plan users and read only — Defaults to the `false` value. example: true sdkGitConnection: type: object description: Information about the SDK's Git connection to a Postman element. required: - sdkGitConnectionId - source - language - status - repositoryUrl - targetBranch - autoUpdatePullRequestsEnabled - pullRequests - createdAt - updatedAt properties: sdkGitConnectionId: $ref: '#/components/schemas/sdkGitConnectionId' source: $ref: '#/components/schemas/sdkSource' language: $ref: '#/components/schemas/sdkLanguage' status: $ref: '#/components/schemas/sdkGitConnectionStatus' repositoryUrl: type: string format: uri description: The canonical URL of the target Git repository. example: https://git.example.com/engineering/engineering-sdk targetBranch: type: string default: main description: The branch the SDK is published to. This defaults to the `main` value. example: main autoUpdatePullRequestsEnabled: $ref: '#/components/schemas/autoUpdatePullRequestsEnabled' sdk: $ref: '#/components/schemas/sdk' pullRequests: type: array description: A list of SDK update pull requests on the Git connection, in order of newest first by its `updatedAt` property. This returns an empty value if no pull requests have been opened yet. For full pull request details, use the GET `/sdk-git-connections/{sdkGitConnectionId}/pull-requests` endpoint. items: $ref: '#/components/schemas/simpleSdkGitConnectionPullRequest' createdAt: type: string format: date-time description: The date and time at which the Git connection was created. example: '2026-05-30T10:21:14Z' updatedAt: type: string format: date-time description: The date and time at which the Git connection was last updated. example: '2026-05-30T10:21:14Z' sdkGitConnectionList: type: object required: - data - meta properties: data: type: array description: A list of SDK Git connections. items: $ref: '#/components/schemas/sdkGitConnection' meta: $ref: '#/components/schemas/metaNextCursorTotal' createSdkGitConnection: type: object required: - source - language - repositoryUrl properties: source: $ref: '#/components/schemas/sdkSource' language: $ref: '#/components/schemas/sdkLanguage' repositoryUrl: type: string format: uri description: The canonical URL of the target Git repository. example: https://git.example.com/acme/acme-sdk targetBranch: type: string default: main description: The branch the SDK is published to. Defaults to `main`. example: main autoUpdatePullRequestsEnabled: $ref: '#/components/schemas/autoUpdatePullRequestsEnabled' updateSdkGitConnection: type: object required: - status properties: status: type: string description: The updated SDK Git connection lifecycle state. enum: - active - disconnected example: active autoUpdatePullRequestsEnabled: $ref: '#/components/schemas/autoUpdatePullRequestsEnabled' sdkGitConnectionPullRequest: type: object description: Information about a pull request that shipped the SDK update. required: - number - url - status - createdAt - updatedAt properties: number: type: integer minimum: 1 description: The pull request's ID. example: 87 url: type: string format: uri description: The pull request's URL. example: https://git.example.com/engineering/engineering-sdk/pull/87 status: $ref: '#/components/schemas/sdkGitConnectionPRStatus' sdk: $ref: '#/components/schemas/sdk' createdAt: type: string format: date-time description: The date and time at which the pull request was created. example: '2026-05-30T10:21:14Z' updatedAt: type: string format: date-time description: The date and time at which the pull request was last updated. example: '2026-05-30T10:21:14Z' sdkGitConnectionPullRequestList: type: object required: - data - meta properties: data: type: array description: A list of SDK update pull requests on the Git connection. items: $ref: '#/components/schemas/sdkGitConnectionPullRequest' meta: $ref: '#/components/schemas/metaNextCursorTotal' limitDefault10Max25: type: integer default: 10 minimum: 1 maximum: 25 example: 10 searchFilterPrivateApiNetwork: type: object description: Filters by private API network membership. Supported for all element types. properties: $eq: type: boolean description: If true, return only resources that are part of the Private API Network. example: true $ne: type: boolean description: If true, exclude resources that are part of the Private API Network. example: true searchFilterPublisherIsVerified: type: object description: Filters by publisher verification status. Supported for all element types. properties: $eq: type: boolean description: If true, return only results from verified publishers. example: true $ne: type: boolean description: If true, exclude results from verified publishers. example: true searchFilterVisibility: type: object description: | Filters by workspace visibility. Supported for all element types. One of: - `internal` — Only visible to the organization's team members. - `public` — Visible to all Postman users. - `partner` — Visible to assigned external partner users. properties: $eq: type: string description: The visibility value to match. enum: - internal - public - partner example: internal $ne: type: string description: The visibility value to exclude. enum: - internal - public - partner example: internal searchFilterWorkspaceId: type: object description: Filters by workspace ID. Supported for all element types. properties: $eq: type: string description: The workspace ID to match. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 $ne: type: string description: The workspace ID to exclude. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 $in: type: array description: A list of workspace IDs to match. items: $ref: '#/components/schemas/workspaceId' $nin: type: array description: A list of workspace IDs to exclude. items: $ref: '#/components/schemas/workspaceId' searchFilterCollectionId: type: object description: Filters by collection ID. Supported for `requests` and `collections` only. properties: $eq: type: string description: The collection ID to match. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 $ne: type: string description: The collection ID to exclude. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 $in: type: array description: A list of collection IDs to match. items: $ref: '#/components/schemas/collectionUid' $nin: type: array description: A list of collection IDs to exclude. items: $ref: '#/components/schemas/collectionUid' tagName: type: string example: FEATURE searchFilterTags: type: object description: Filters by tags. Supported for `workspaces` and `collections`. properties: $eq: type: string description: The tag to match. example: FEATURE $ne: type: string description: The tag to exclude. example: FEATURE $in: type: array description: A list of tags to match. items: $ref: '#/components/schemas/tagName' $nin: type: array description: A list of tags to exclude. items: $ref: '#/components/schemas/tagName' httpMethod: type: string example: POST searchFilterRequestHttpMethod: type: object description: Filters by HTTP method (for example, `GET` or `POST`). Supported for `requests` only. properties: $eq: type: string description: The HTTP method to match. example: POST $ne: type: string description: The HTTP method to exclude. example: POST $in: type: array description: A list of HTTP methods to match. items: $ref: '#/components/schemas/httpMethod' $nin: type: array description: A list of HTTP methods to exclude. items: $ref: '#/components/schemas/httpMethod' searchFilterRequestId: type: object description: Filters by request ID. Supported for `requests` only. properties: $eq: type: string description: The request ID to match. example: c82dd02c-4870-4907-8fcb-593a876cf05b $ne: type: string description: The request ID to exclude. example: c82dd02c-4870-4907-8fcb-593a876cf05b $in: type: array description: A list of request IDs to match. items: $ref: '#/components/schemas/collectionRequestId' $nin: type: array description: A list of request IDs to exclude. items: $ref: '#/components/schemas/collectionRequestId' searchFilterSpecId: type: object description: Filters by specification ID. Supported for `specs` only. properties: $eq: type: string description: The specification ID to match. example: 73e15000-bc7a-4802-b80e-05fff18fd7f8 $ne: type: string description: The specification ID to exclude. example: 73e15000-bc7a-4802-b80e-05fff18fd7f8 $in: type: array description: A list of specification IDs to match. items: $ref: '#/components/schemas/specId' $nin: type: array description: A list of specification IDs to exclude. items: $ref: '#/components/schemas/specId' flowId: type: string example: 66e05eb68905ca003d6f57d4 searchFilterFlowId: type: object description: Filters by flow ID. Supported for `flows` only. properties: $eq: type: string description: The flow ID to match. example: 66e05eb68905ca003d6f57d4 $ne: type: string description: The flow ID to exclude. example: 66e05eb68905ca003d6f57d4 $in: type: array description: A list of flow IDs to match. items: $ref: '#/components/schemas/flowId' $nin: type: array description: A list of flow IDs to exclude. items: $ref: '#/components/schemas/flowId' workspaceDocumentId: type: string example: 28d729e0-67f6-4551-9667-c3cc4e7b920f searchFilterWorkspaceDocuments: type: object description: Filters by workspace document ID. Supported for workspace documents. properties: $eq: type: string description: The workspace document ID to match. example: '1' $ne: type: string description: The workspace document ID to exclude. example: '1' $in: type: array description: A list of workspace document IDs to match. items: $ref: '#/components/schemas/workspaceDocumentId' $nin: type: array description: A list of workspace document IDs to exclude. items: $ref: '#/components/schemas/workspaceDocumentId' searchFilterEnvironmentId: type: object description: Filters by environment ID. Supported for `environments` only. properties: $eq: type: string description: The environment ID to match. example: 5daabc50-8451-43f6-922d-96b403b4f28e $ne: type: string description: The environment ID to exclude. example: 5daabc50-8451-43f6-922d-96b403b4f28e $in: type: array description: A list of environment IDs to match. items: $ref: '#/components/schemas/environmentId' $nin: type: array description: A list of environment IDs to exclude. items: $ref: '#/components/schemas/environmentId' createdByString: type: string example: '12345678' searchFilterCreatedBy: type: object description: Filters by the resource creator's user ID. Supported for all element types. properties: $eq: type: string description: The creator ID to match. example: '12345678' $ne: type: string description: The creator ID to exclude. example: '12345678' $in: type: array description: A list of creator IDs to match. items: $ref: '#/components/schemas/createdByString' $nin: type: array description: A list of creator IDs to exclude. items: $ref: '#/components/schemas/createdByString' organizationIdString: type: string example: '1' searchFilterOrgId: type: object description: Filters by organization ID. Supported for all element types. properties: $eq: type: string description: The organization ID to match. example: '1' $ne: type: string description: The organization ID to exclude. example: '1' $in: type: array description: A list of organization IDs to match. items: $ref: '#/components/schemas/organizationIdString' $nin: type: array description: A list of organization IDs to exclude. items: $ref: '#/components/schemas/organizationIdString' teamIdString: type: string example: '123' searchFilterTeamId: type: object description: Filters by team ID. Supported for all element types. properties: $eq: type: string description: The team ID to match. example: '123' $ne: type: string description: The team ID to exclude. example: '123' $in: type: array description: A list of team IDs to match. items: $ref: '#/components/schemas/teamIdString' $nin: type: array description: A list of team IDs to exclude. items: $ref: '#/components/schemas/teamIdString' searchFilterGitConnected: type: object description: Filters by Git connection status. Supported for `workspaces`, `collections`, `requests`, `environments`, `specs`, `flows`, and `documents`. properties: $eq: type: boolean description: If true, return only resources connected to Git. example: true $ne: type: boolean description: If true, exclude resources connected to Git. example: true collectionRequestResourceType: type: string example: http searchFilterRequestResourceType: type: object description: Filters by resource type variant (for example, `http` or `grpc`). Supported for `requests` only. properties: $eq: type: string description: The resource type to match. example: http $ne: type: string description: The resource type to exclude. example: http $in: type: array description: A list of resource types to match. items: $ref: '#/components/schemas/collectionRequestResourceType' $nin: type: array description: A list of resource types to exclude. items: $ref: '#/components/schemas/collectionRequestResourceType' searchFilters: type: object minProperties: 1 maxProperties: 1 description: A single filter condition. properties: privateNetwork: $ref: '#/components/schemas/searchFilterPrivateApiNetwork' publisherIsVerified: $ref: '#/components/schemas/searchFilterPublisherIsVerified' visibility: $ref: '#/components/schemas/searchFilterVisibility' workspaceId: $ref: '#/components/schemas/searchFilterWorkspaceId' collectionId: $ref: '#/components/schemas/searchFilterCollectionId' tags: $ref: '#/components/schemas/searchFilterTags' method: $ref: '#/components/schemas/searchFilterRequestHttpMethod' requestId: $ref: '#/components/schemas/searchFilterRequestId' specificationId: $ref: '#/components/schemas/searchFilterSpecId' flowId: $ref: '#/components/schemas/searchFilterFlowId' documentId: $ref: '#/components/schemas/searchFilterWorkspaceDocuments' environmentId: $ref: '#/components/schemas/searchFilterEnvironmentId' createdBy: $ref: '#/components/schemas/searchFilterCreatedBy' organizationId: $ref: '#/components/schemas/searchFilterOrgId' teamId: $ref: '#/components/schemas/searchFilterTeamId' isGitConnected: $ref: '#/components/schemas/searchFilterGitConnected' type: $ref: '#/components/schemas/searchFilterRequestResourceType' searchFilterAndOperation: type: array description: A list of filter conditions that must all be true. Each item must contain exactly one filter. items: $ref: '#/components/schemas/searchFilters' searchPostmanResources: type: object required: - elementType properties: q: type: string description: The search query text. This is case-insensitive. example: postman elementType: type: string description: The type of Postman resource to search for. enum: - requests - collections - workspaces - environments - documents - flows - specs example: requests ownership: type: string default: organization description: | The ownership scope for search results. One of: - `organization` (default) — Resources owned by the user's team. - `external` — Resources not owned by the user's team. - `all` — All resources regardless of ownership. enum: - organization - external - all example: organization filters: type: object description: The search filters to narrow results. required: - $and properties: $and: $ref: '#/components/schemas/searchFilterAndOperation' searchMetaData: type: object description: Pagination metadata for the search results. properties: nextCursor: type: string description: The pagination cursor that points to the next record in the results set. example: eyJsaW1pdCI6MTAsImZyb20iOjEwfQ== q: type: string description: The search query text. example: How to create a DB in notion? total: type: integer description: The number of records found. example: 2 searchResourceTeamData: type: object nullable: true description: Information about the team associated with the resource. This returns a null value for the `user` publisher type. properties: id: type: string nullable: true description: The team's ID. example: '123' name: type: string nullable: true description: The team's name. example: API Testing Team searchRequestsCollectionData: type: object description: Information about the collection containing the resource. Returns only for requests. properties: id: type: string description: The collection's ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 name: type: string description: The collection's name. example: API Testing Collection searchResourceWorkspacesData: type: object description: Information about the workspace containing the resource. properties: id: type: string description: The workspace's ID. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: type: string description: The workspace's name. example: API Testing searchResourceOrganizationData: type: object nullable: true description: Information about the organization that published the resource. This returns a null value for the `user` publisher type. properties: id: type: string nullable: true description: The organization's ID. example: '1' name: type: string nullable: true description: The organization's name. example: API Engineering Org isVerified: type: boolean description: If true, the organization is verified by Postman. example: false searchResourceWebData: type: object description: The link to view the resource in the Postman web app. properties: href: type: string format: uri description: The URL to view the resource in the Postman web app. example: https://go.postman.co/request/12345678-b4c5d6e7-f8a9-0123-bcde-456789012345 searchResourceLinksSelfData: type: object description: The link to the resource through the Postman API. properties: href: type: string format: uri description: The URL to access the resource through the Postman API. example: https://api.postman.com/collections/12345678-33445566-1122-3344-5566-778899001122/requests/12345678-b4c5d6e7-f8a9-0123-bcde-456789012345 searchResourceLinksData: type: object description: Information about the resource's hypermedia links. properties: web: $ref: '#/components/schemas/searchResourceWebData' self: $ref: '#/components/schemas/searchResourceLinksSelfData' searchPostmanResourcesResponseData: type: object description: Information about the Postman resource. properties: id: type: string description: The resource's ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 name: type: string description: The resource's name. example: Get Team Members method: type: string description: The request's HTTP method. Returns only for requests. example: GET type: type: string description: The resource type variant. For requests, returns the protocol. For workspace documents, the document's format, such as Markdown. Returns only for requests and documents. example: http description: type: string description: A brief description of the resource, if available. example: Retrieve all team members summary: type: string description: A brief summary of the resource, if available. Returns only for workspaces and collections. example: A collection of requests to manage team members url: type: string format: uri description: The request URL of the resource. Returns only for requests. example: https://postman-echo.com/get?team=alpha isPinnedToWorkspace: example: false type: boolean description: If true, the workspace document is pinned to its workspace. Returns only for workspace documents. tags: type: array description: A list of tags associated with the resource. Returns only for workspaces and collections. items: $ref: '#/components/schemas/tagName' specificationId: type: string description: The specification's ID. Returns only for specifications. example: 73e15000-bc7a-4802-b80e-05fff18fd7f8 specificationType: type: string description: The specification's type. Returns only for specifications. example: OPENAPI:3.0 specificationName: type: string description: The specification's name. Returns only for specifications. example: Test API isPrivateNetworkEntity: type: boolean description: Whether the resource is part of a private API network. example: false createdBy: type: string description: The ID of the user who created the resource. example: '12345678' team: $ref: '#/components/schemas/searchResourceTeamData' isGitConnected: type: boolean description: If true, the resource is connected to Git. Returns only for workspaces, collections, requests, specifications, and flows. example: false collection: $ref: '#/components/schemas/searchRequestsCollectionData' workspace: $ref: '#/components/schemas/searchResourceWorkspacesData' organization: $ref: '#/components/schemas/searchResourceOrganizationData' links: $ref: '#/components/schemas/searchResourceLinksData' searchPostmanResourcesResponse: type: object properties: meta: $ref: '#/components/schemas/searchMetaData' data: type: array description: A list of Postman elements that match the search query and filters. items: $ref: '#/components/schemas/searchPostmanResourcesResponseData' specType: type: string description: The type of API specification. enum: - OPENAPI:2.0 - OPENAPI:3.0 - OPENAPI:3.1 - ASYNCAPI:2.0 - ASYNCAPI:3.0 - PROTOBUF:2 - PROTOBUF:3 - GRAPHQL - SMITHY:2.0 example: OPENAPI:3.0 getAllSpecs: type: object properties: meta: description: The response's meta information for paginated results. allOf: - $ref: '#/components/schemas/metaData' specs: type: array description: A list of API specifications. items: type: object description: Information about the API specification. properties: id: type: string description: The specification's ID. example: 73e15000-bc7a-4802-b80e-05fff18fd7f8 name: type: string description: The specification's name. example: Sample API type: $ref: '#/components/schemas/specType' createdBy: type: integer description: The user ID of the user that created the specification. example: 12345678 updatedBy: type: integer description: The ID of the user who updated the specification. example: 12345678 createdAt: type: string format: date-time description: The date and time at which the specification was created. example: '2025-03-15T13:48:28.000Z' updatedAt: type: string format: date-time description: The date and time at which the specification was updated. example: '2025-03-15T13:48:28.000Z' createSpec: type: object required: - name - type - files properties: name: type: string description: The specification's name. example: Sample API type: $ref: '#/components/schemas/specType' files: type: array description: A list of the specification's files and their contents. items: anyOf: - title: Multi-File Spec type: object required: - path - content - type properties: path: type: string description: The file's path. Accepts .json, .yaml, and .proto types. example: schemas.json content: type: string description: The file's stringified contents. example: |- { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "#/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } } type: type: string description: | The type of file. This property is required when creating multi-file specifications: - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and references other (`DEFAULT`) spec files. Multi-file specs can only have one root file. - `DEFAULT` — A file referenced by the `ROOT` file. enum: - DEFAULT - ROOT example: DEFAULT - title: Single File Spec type: object required: - path - content properties: path: type: string description: The file's path. Accepts .json, .yaml, .proto, .graphql, and .smithy file types. example: index.json content: type: string description: The file's stringified contents. example: |- { "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Sample API", "description": "Buy or rent spacecrafts" }, "paths": { "/spacecrafts/{spacecraftId}": { "parameters": [ { "name": "spacecraftId", "description": "The unique identifier of the spacecraft", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SpacecraftId" } } ], "get": { "summary": "Read a spacecraft", "responses": { "200": { "description": "The spacecraft corresponding to the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Spacecraft" } } } }, "404": { "description": "No spacecraft found for the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "#/components/schemas/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key" } } }, "security": [ { "ApiKey": [ ] } ] } createSpecResponse: type: object properties: name: type: string description: The API specification's name. example: Sample API type: $ref: '#/components/schemas/specType' id: type: string description: The specification's ID. example: b4fc1bdc-6587-4f9b-95c9-f768146089b4 createdAt: type: string format: date-time description: The date and time at which the specification file was created. example: '2025-03-15T13:48:28.000Z' updatedAt: type: string format: date-time description: The date and time at which the file was last updated. example: '2025-03-15T13:48:28.000Z' createdBy: type: integer description: The user ID of the user that created the file. example: 12345678 updatedBy: type: integer description: The user ID of the user that last updated the specification file. example: 12345678 fileFormat: type: string description: The specification's file format. enum: - json - yaml - proto - graphql - smithy example: yaml specData: title: Spec Information type: object description: Information about the API specification. properties: id: type: string description: The specification's ID. example: 73e15000-bc7a-4802-b80e-05fff18fd7f8 fileFormat: $ref: '#/components/schemas/fileFormat' name: type: string description: The specification's name. example: Sample API type: $ref: '#/components/schemas/specType' createdBy: type: integer description: The user ID of the user that created the specification. example: 12345678 updatedBy: type: integer description: The ID of the user who updated the specification. example: 12345678 createdAt: type: string format: date-time description: The date and time at which the specification was created. example: '2025-03-15T13:48:28.000Z' updatedAt: type: string format: date-time description: The date and time at which the specification was updated. example: '2025-03-15T13:48:28.000Z' updateSpecProperties: type: object required: - name properties: name: type: string description: The spec's name. example: Sample API updateSpecPropertiesResponse: type: object properties: id: type: string description: The specification's ID. example: ae2b9ab2-28f2-401d-912f-eca09a78e98b type: $ref: '#/components/schemas/specType' createdBy: type: integer description: The ID of the user that created the specification. example: 12345678 updatedBy: type: integer description: The ID of the user that last updated the specification. example: 12345678 createdAt: type: string format: date-time description: The date and time at which the specification was created. example: '2025-03-15T13:48:28.000Z' updatedAt: type: string format: date-time description: The date and time at which the specification was last updated. example: '2025-03-15T13:48:28.000Z' name: type: string description: The API specification's name. example: Sample API apiSpecSyncOptions: type: object minProperties: 1 properties: syncOptions: type: object description: Information about the specification sync options. properties: syncExamples: type: boolean default: true description: If true, updates made to examples in the specification or to example values in the generated collection stay synchronized. example: true deleteOrphanedRequests: type: boolean default: true description: If true, deletes requests and endpoints that no longer exist in the source during sync. example: true specFileData: title: Spec File Information type: object description: Information about the API specification file. properties: id: type: string description: The file's ID. example: 3860602b-7a92-45a6-8b60-725ff7b453d5 path: type: string description: The file's path. example: index.json name: type: string description: The file's name. example: index.json createdBy: type: integer description: The user ID of the user that created the file. example: 12345678 updatedBy: type: integer description: The ID of the user who updated the file. example: 12345678 createdAt: type: string format: date-time description: The date and time at which the file was created. example: '2025-07-22T18:42:18.000Z' updatedAt: type: string format: date-time description: The date and time at which the file was updated. example: '2025-07-22T18:47:32.000Z' type: type: string enum: - ROOT - DEFAULT description: | The type of file: - `ROOT` — A file containing the full OpenAPI structure and references other (DEFAULT) spec files. - `DEFAULT` — A file referenced by the `ROOT` file. example: ROOT getSpecFiles: type: object description: Information about the specification's files. properties: files: type: array description: A list of the API specification's files. items: $ref: '#/components/schemas/specFileData' meta: description: The response's meta information for paginated results. allOf: - $ref: '#/components/schemas/metaData' createSpecFile: type: object required: - path - content properties: path: type: string description: The file's path. Accepts JSON or YAML files. example: schemas.json content: type: string description: The file's stringified contents. example: |- { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "#/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } } createUpdateSpecFileResponse: type: object description: Information about the API specification file. properties: createdAt: type: string format: date-time description: The date and time at which the file was created. example: '2025-07-22T19:29:08.000Z' createdBy: type: integer description: The user ID of the user that created the file. example: 12345678 id: type: string description: The file's ID. example: b4fc1bdc-6587-4f9b-95c9-f768146089b4 path: type: string description: The file's path. example: index.json updatedAt: type: string format: date-time description: The date and time at which the file was updated. example: '2025-07-22T19:29:08.000Z' updatedBy: type: integer description: The ID of the user who updated the file. example: 12345678 type: type: string default: DEFAULT description: | The type of file: - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and references other (`DEFAULT`) spec files. Multi-file specs can only have one root file. - `DEFAULT` — A file referenced by the `ROOT` file. enum: - DEFAULT - ROOT example: ROOT filePath: type: string example: index.json getSpecFile: type: object description: Information about the API specification file. properties: id: type: string description: The file's ID. example: ae2b9ab2-28f2-401d-912f-eca09a78e98b name: type: string description: The file's name. example: index.json path: type: string description: The file's path. example: index.json createdBy: type: integer description: The user ID of the user that created the file. example: 12345678 updatedBy: type: integer description: The ID of the user who updated the file. example: 12345678 createdAt: type: string format: date-time description: The date and time at which the file was created. example: '2025-07-22T19:29:08.000Z' updatedAt: type: string format: date-time description: The date and time at which the file was updated. example: '2025-07-22T19:29:08.000Z' type: type: string description: | The type of file: - `ROOT` — A file containing the full OpenAPI structure and references other (DEFAULT) spec files. - `DEFAULT` — A file referenced by the `ROOT` file. enum: - ROOT - DEFAULT example: ROOT content: type: string description: The file's stringified contents. example: |- { "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Sample API", "description": "Buy or rent spacecrafts" }, "paths": { "/spacecrafts/{spacecraftId}": { "parameters": [ { "name": "spacecraftId", "description": "The unique identifier of the spacecraft", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SpacecraftId" } } ], "get": { "summary": "Read a spacecraft", "responses": { "200": { "description": "The spacecraft corresponding to the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Spacecraft" } } } }, "404": { "description": "No spacecraft found for the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "#/components/schemas/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key" } } }, "security": [ { "ApiKey": [ ] } ] } updateSpecFile: type: object description: You must pass one of the accepted values in this request body. Also, this request body does not accept multiple properties in a single call. For example, you cannot pass both the `content` and `type` property at the same time. properties: name: type: string description: The file's name. example: index.json type: type: string description: | The type of file: - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and references other (`DEFAULT`) spec files. Multi-file specs can only have one root file. - `DEFAULT` — A file referenced by the `ROOT` file. enum: - DEFAULT - ROOT example: ROOT content: type: string description: The specification's stringified contents. example: |- { "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Sample API", "description": "Buy or rent spacecrafts" }, "paths": { "/spacecrafts/{spacecraftId}": { "parameters": [ { "name": "spacecraftId", "description": "The unique identifier of the spacecraft", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SpacecraftId" } } ], "get": { "summary": "Read a spacecraft", "responses": { "200": { "description": "The spacecraft corresponding to the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Spacecraft" } } } }, "404": { "description": "No spacecraft found for the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "#/components/schemas/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key" } } }, "security": [ { "ApiKey": [ ] } ] } elementTypeCollection: type: string enum: - collection example: collection specCollectionData: title: Spec Collection Information type: object description: Information about the API specification's collection. properties: id: type: string description: The collection's ID. example: b4fc1bdc-6587-4f9b-95c9-f768146089b4 name: type: string description: The collection's name. example: Sample API state: type: string description: The sync state of the collection and its API specification. enum: - in-sync - out-of-sync - sync-in-progress example: in-sync createdAt: type: string format: date-time description: The date and time at which the collection was generated. example: '2025-03-15T13:48:28.000Z' updatedAt: type: string format: date-time description: The date and time at which the collection was updated. example: '2025-03-15T13:48:28.000Z' createdBy: type: integer description: The user ID of the user that generated the collection. example: 12345678 getSpecCollections: type: object properties: collections: type: array description: A list of the API specification's generated collections. items: $ref: '#/components/schemas/specCollectionData' meta: description: The response's meta information for paginated results. allOf: - $ref: '#/components/schemas/metaData' generateCollection: type: object required: - name - options properties: name: type: string description: The generated collection's name. example: Sample API options: $ref: '#/components/schemas/generateCollectionOptions' tagId: type: string example: 97d2c74e-19de-426d-9763-8e7400429759 getSpecVersionTag: type: object properties: data: type: array description: A list of the version tag's files and folders. items: type: object description: Information about the element. properties: id: type: string description: The file's ID. example: 7a65e696-76fe-462d-a374-b4de06cac805 name: type: string description: The file's name. example: spacecrafts.yaml updatedBy: type: string description: The ID of the user who updated the file. example: '12345678' createdAt: type: string format: date-time description: The date and time at which the file was created. example: '2025-07-08T19:33:39.000Z' updatedAt: type: string format: date-time description: The date and time at which the file was updated. example: '2025-07-08T20:03:33.000Z' createdBy: type: string description: The user ID of the user that created the file. example: '12345678' type: type: string enum: - FILE - FOLDER description: The file's type. example: FILE path: type: string description: The file's path. example: components/responses/spacecrafts.yaml fileType: type: string enum: - ROOT - DEFAULT description: | The type of file: - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and references other (`DEFAULT`) spec files. Multi-file specs can only have one root file. - `DEFAULT` — A file referenced by the `ROOT` file. This file contains a subset of the OpenAPI structure, such as specific components or paths. This value doesn't return for folders. example: DEFAULT content: type: string description: The file's content. Folders don't return this property. example: |- SuccessfulResponse: description: The spacecraft corresponding to the provided `spacecraftId` content: application/json: schema: $ref: ../schemas/spacecrafts.yaml#/Spacecraft NotFound: description: No spacecraft found for the provided `spacecraftId` content: application/problem+json: schema: $ref: ../schemas/spacecrafts.yaml#/Error UnexpectedError: description: Unexpected error content: application/problem+json: schema: $ref: ../schemas/spacecrafts.yaml#/Error parentId: type: string description: The file's parent folder ID. This property is absent for ROOT-level files. example: 2647f42c-3307-414f-b949-9a9b07b4cbd9 getSpecVersionTags: type: object properties: data: type: array description: A list of the specification's version tags. items: type: object description: Information about the version tag. properties: id: type: string description: The version tag's ID. example: 2cefdde6-f912-4cb4-86b1-c874d7d5ea03 name: type: string description: The version tag's name. example: 1.0.0 meta: description: The response's meta information for paginated results. allOf: - $ref: '#/components/schemas/meta' createSpecVersionTag: type: object required: - name properties: name: type: string description: The version tag's name. createSpecVersionTagResponse: type: object properties: data: type: object description: Information about the created version tag. properties: id: type: string description: The version tag's ID. example: 9c3c45e4-183a-4bc4-92aa-6b39d047377d name: type: string description: The version tag's name. example: 1.0.0 identifierType: type: string example: scim limitDefault50: type: integer default: 50 example: 2 teamSettingsQuery: type: boolean default: false example: true userRolesQuery: type: boolean default: false example: true teamData: type: object description: Information about the team. properties: createdAt: type: string format: date-time description: The date and time at which the team was created. example: '2025-01-27T10:36:02.000Z' updatedAt: type: string format: date-time description: The date and time at which the team was last updated. example: '2025-02-26T08:17:42.000Z' id: type: integer description: The team's ID. example: 123 name: type: string description: The team's name. example: Testing Team handle: type: string description: The team's handle. example: testing-team description: type: string description: A description about the team. example: API testing team. organizationId: type: integer description: The team's organization ID. example: 1 createdBy: anyOf: - type: integer title: User ID - type: string title: SCIM ID description: The user ID of the user who created the team. example: 12345678 enabled: type: boolean description: If true, the team is active. example: true memberCount: type: integer description: The number of members in the team. example: 6 metaDataNextCursor: title: Meta Information type: object description: The response's meta information for paginated results. properties: nextCursor: type: string nullable: true description: The pagination cursor that points to the next record in the results set. example: NTczNDg= teamsErrorDetail: title: Error Details type: object description: An explanation about the problem. properties: error: type: object description: Information about the error. properties: name: type: string description: The error name. example: BadRequest message: type: string description: The error message. example: Team feature is not available for your organization. teamsErrorDetailInvalidEntries: title: Invalid Entries for Manage Team Member Roles type: object description: An explanation about the problem. properties: error: type: string description: The error message. example: Found invalid entities result: type: array description: A list of invalid entities. items: type: object properties: entityType: type: string description: The entity type. example: user entityId: anyOf: - type: integer title: User ID - type: string title: SCIM ID description: The entity ID. example: 87654321 role: type: string nullable: true description: The assigned role. example: null status: type: string description: The `Invalid` response status. example: Invalid reason: type: string description: The reason for the error. example: Existing and new roles are empty teamsError: title: Teams API Error Schema type: object properties: type: type: string format: uri-reference description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem. example: https://api.postman.com/problems/length-required status: type: integer format: http-status-code description: The HTTP status code generated by the origin server. example: 400 title: type: string description: A short summary of the problem. example: Bad Request detail: description: Information about the error. oneOf: - $ref: '#/components/schemas/teamsErrorDetail' - $ref: '#/components/schemas/teamsErrorDetailInvalidEntries' instance: type: string description: The URI reference that identifies the specific occurrence of the problem. example: /teams createTeam: type: object properties: name: type: string description: The team's name. Accepts only alphanumeric characters and spaces. example: Testing Team description: type: string nullable: true description: The team's description. example: API testing team. createGetTeamResponse: type: object properties: team: type: object description: Information about the team. properties: createdAt: type: string format: date-time description: The date and time at which the team was created. example: '2025-02-26T08:17:42.000Z' updatedAt: type: string format: date-time description: The date and time at which the team was last updated. example: '2025-02-26T08:17:42.000Z' id: type: integer description: The team's ID. example: 123 name: type: string description: The team's name. example: Testing Team handle: type: string description: The team's handle. example: testing-team description: type: string description: A description about the team. example: API testing team. organizationId: type: integer description: The team's organization ID. example: 1 createdBy: anyOf: - type: integer title: User ID - type: string title: SCIM ID description: The user ID of the user who created the team. example: 12345678 enabled: type: boolean description: If true, the team is active. example: true teamId: type: integer example: 123 teamsInclude: type: string enum: - members - userRoles example: members getTeamAccessRequests: type: object properties: data: type: array description: A list of access requests. items: type: object description: Information about the access request. properties: createdAt: type: string format: date-time description: The date and time the access request was created. example: '2025-10-10T18:54:09.000Z' updatedAt: type: string format: date-time description: The date and time the access request was last updated. example: '2025-10-10T18:54:09.000Z' id: type: integer description: The access request's ID. example: 1 role: type: string description: The requested team role. example: TEAM_DEVELOPER enum: - TEAM_MANAGER - TEAM_DEVELOPER - TEAM_GUEST_DEVELOPER - TEAM_GUEST_VIEWER - TEAM_PARTNER_MANAGER - TEAM_PARTNER_LEAD - TEAM_GUEST - TEAM_PARTNER - TEAM_COMMUNITY_MANAGER requestType: type: string description: The access request type. example: REQUEST_TO_ADD_MEMBERS reason: type: string description: The reason the access request was created. example: Needs the developer role. status: type: string description: The access request's status. example: Requested entityType: type: string description: The entity type. example: user entityId: anyOf: - type: integer title: User ID - type: string title: SCIM ID description: The entity's ID. example: 1317604 objectType: type: string description: The entity type. example: team objectId: type: integer description: The entity's ID. example: 1 createdBy: anyOf: - type: integer title: User ID - type: string title: SCIM ID description: The user ID of the user who created the access request. example: 12345678 metadata: $ref: '#/components/schemas/metaDataNextCursor' teamEntityInfo: type: object required: - entityType - entityId properties: entityType: type: string description: The entity type. enum: - user - group - team - organization example: user entityId: anyOf: - type: integer title: User ID - type: string title: SCIM ID description: The entity's ID. example: '87654321' createAccessRequest: type: object required: - entityList - role - reason - requestType properties: entityList: type: array description: A list of the entities for which to create access requests. items: $ref: '#/components/schemas/teamEntityInfo' role: type: string nullable: true description: The team role to request. enum: - TEAM_MANAGER - TEAM_DEVELOPER - TEAM_GUEST_DEVELOPER - TEAM_GUEST_VIEWER - TEAM_PARTNER_MANAGER - TEAM_PARTNER_LEAD - TEAM_GUEST - TEAM_PARTNER - TEAM_COMMUNITY_MANAGER example: TEAM_DEVELOPER reason: type: string description: The reason for the access request. example: Needs the developer role. requestType: type: string description: The type of access request. enum: - REQUEST_TO_ADD_MEMBERS - REQUEST_TO_JOIN - UPGRADE_ROLE example: REQUEST_TO_ADD_MEMBERS teamsAccessRequestData: type: object properties: entityType: type: string description: The entity type. example: user entityId: anyOf: - type: integer title: User ID - type: string title: SCIM ID description: The entity's ID. example: 87654321 role: type: string description: The entity's role. example: TEAM_MANAGER previousRole: type: string nullable: true description: The entity's previous role. This value only returns if the entity's role is modified. example: TEAM_DEVELOPER status: type: string description: The request's status. example: Accepted reason: type: string description: The reason for the access request. This only returns if there's an issue with the request. example: Entity already has this role. createAccessRequestResponse: type: object properties: result: type: array description: A list of the created access requests. items: $ref: '#/components/schemas/teamsAccessRequestData' accessRequestId: type: integer example: 12345 approveDenyAccessRequest: type: object required: - action properties: action: type: string description: Whether to approve or deny the access request. enum: - approve - deny example: approve approveDenyAccessRequestResponse: type: object properties: result: type: object description: Information about the approved or denied access request. properties: entityType: type: string description: The entity type. example: user entityId: anyOf: - type: integer title: User ID - type: string title: SCIM ID description: The entity's ID. example: 87654321 role: type: string description: The requested team role. example: TEAM_DEVELOPER previousRole: type: string nullable: true description: The entity's previous role. This value only returns if the entity's role is modified. example: TEAM_DEVELOPER status: type: string description: The access request's status. example: Accepted accessRequest: type: object description: Information about the access request. properties: id: type: integer description: The access request's ID. example: 1095 requestType: type: string description: The access request type. example: REQUEST_TO_ADD_MEMBERS reason: type: string description: The reason the access request was created. example: '' status: type: string description: The access request's status. example: Accepted objectType: type: string description: The entity type. example: team objectId: type: integer description: The entity's ID. example: 1095 createdBy: type: integer description: The user ID of the user who created the access request. example: 87654321 teamRoles: type: string enum: - TEAM_MANAGER - TEAM_DEVELOPER - TEAM_GUEST_DEVELOPER - TEAM_GUEST_VIEWER - TEAM_PARTNER_MANAGER - TEAM_PARTNER_LEAD - TEAM_GUEST - TEAM_PARTNER - TEAM_COMMUNITY_MANAGER example: TEAM_MANAGER usersInfo: type: object description: The role assignments keyed by user ID. properties: '{{userId}}': type: array description: A list of the user's roles. The array's name is the user's ID. items: $ref: '#/components/schemas/teamRoles' userGroupsInfo: type: object description: The role assignments keyed by user group ID. properties: '{{userGroupId}}': type: array description: A list of the user group's roles. The array's name is the group's ID. items: $ref: '#/components/schemas/teamRoles' orgsInfo: type: object description: The role assignments keyed by organization ID. properties: '{{orgId}}': type: array description: A list of the organization's roles. The array's name is the organization's ID. items: $ref: '#/components/schemas/teamRoles' teamsInfo: type: object description: The role assignments keyed by team ID. properties: '{{teamId}}': type: array description: A list of the team's roles. The array's name is the team's ID. items: $ref: '#/components/schemas/teamRoles' manageTeamMemberRolesAdd: type: object description: Information about the bulk `add` operation. properties: users: description: The role assignments to add, keyed by user ID. allOf: - $ref: '#/components/schemas/usersInfo' groups: description: The role assignments to add, keyed by user group ID. allOf: - $ref: '#/components/schemas/userGroupsInfo' orgs: description: The role assignments to add, keyed by organization ID. allOf: - $ref: '#/components/schemas/orgsInfo' teams: description: The role assignments to add, keyed by team ID. allOf: - $ref: '#/components/schemas/teamsInfo' manageTeamMemberRolesRemove: type: object description: Information about the bulk `remove` operation. properties: users: description: The role assignments to remove, keyed by user ID. allOf: - $ref: '#/components/schemas/usersInfo' groups: description: The role assignments to remove, keyed by user group ID. allOf: - $ref: '#/components/schemas/userGroupsInfo' orgs: description: The role assignments to remove, keyed by organization ID. allOf: - $ref: '#/components/schemas/orgsInfo' teams: description: The role assignments to remove, keyed by team ID. allOf: - $ref: '#/components/schemas/teamsInfo' manageTeamMemberRoles: type: object description: Information about the bulk add and bulk remove operations. properties: add: description: The role assignments to add. allOf: - $ref: '#/components/schemas/manageTeamMemberRolesAdd' remove: description: The role assignments to remove. allOf: - $ref: '#/components/schemas/manageTeamMemberRolesRemove' manageTeamMemberRolesResponse: type: object properties: result: type: array description: A list of the role changes that were applied. items: type: object properties: entityType: type: string description: The entity type. example: user entityId: anyOf: - type: integer title: User ID - type: string title: SCIM ID description: The entity's ID. example: 12345678 role: type: string nullable: true description: The user's role. example: TEAM_MANAGER previousRole: type: string nullable: true description: The user's previous role. This value only returns if the user's role is modified. example: null status: type: string description: The request's status. example: Accepted removeTeamMembers: type: object properties: entities: type: array description: A list of entities to remove. items: $ref: '#/components/schemas/teamEntityInfo' createGetTeamSettingsResponse: type: object properties: settings: type: object description: Information about the team's settings. properties: rfa_for_add_member: type: string description: If enabled, admins must approve any new team members before they can join. example: enabled rfa_for_add_collaborator: type: string description: If enabled, collaborators require approval before they can access the team's workspaces. example: enabled updateTeamSettings: type: object properties: settings: type: object description: Information about the team settings. properties: rfa_for_add_member: type: string description: If enabled, admins must approve any new team members before they can join. enum: - enabled - disabled example: enabled rfa_for_add_collaborator: type: string description: If enabled, collaborators require approval before they can access the team's workspaces. enum: - enabled - disabled example: enabled teamUser: title: User Information type: object description: Information about the user. properties: id: type: integer description: The user's ID. example: 1 name: type: string description: The user's name. example: Taylor Lee username: type: string description: The user's username. example: taylor-lee email: type: string format: email description: The user's email address. example: taylor.lee@example.com roles: type: array description: The user's roles. items: type: string example: user joinedAt: type: string format: date-time description: The user's join date. example: '2022-11-23T14:38:25.000Z' getTeamUsers: title: Team Users Information type: object properties: data: type: array description: A list of users on the team. items: $ref: '#/components/schemas/teamUser' userId: type: integer example: 1 createWebhook: title: Create Webhook type: object properties: webhook: type: object description: Information about the webhook to create. required: - name - collection properties: collection: type: string format: uid description: The unique ID of the collection to trigger when calling this webhook. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 environment: type: string format: uid description: The unique ID of the environment to trigger when calling this webhook. example: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957 name: type: string description: The webhook's name. On success, the system creates a new monitor with this name in the **Monitors** tab. example: Test Webhook createWebhookResponse: title: Webhook Created type: object properties: webhook: type: object description: Information about the created webhook. properties: id: type: string description: The webhook's ID. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: type: string description: The webhook's name. example: Test Webhook collection: type: string format: uid description: The unique ID of the collection that triggers when calling this webhook. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 webhookUrl: type: string description: The webhook's URL. example: https://newman-api.postman.com/run/12345678/267a6e99-b6da-407c-a96f-03be2d6282fb uid: type: string format: uid description: The webhook's unique ID. example: 12345678-1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 workspaceTypeQuery: type: string example: team enum: - personal - team - private - public - partner workspaceCreatedBy: type: integer example: 12345678 workspacesIncludeQuery: type: string example: scim enum: - mocks:deactivated - scim workspaceElementTypeQuery: type: string example: collection enum: - collection - specification workspaceElementIdQuery: type: string example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 limitMax100: type: integer minimum: 1 maximum: 100 example: 5 workspaceType: type: string description: The type of workspace. enum: - personal - team - private - public - partner example: team workspaceVisibility: type: string description: | The workspace's visibility. [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-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 ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)). - `public` — Everyone can access the workspace. - `partner` — Only invited team members and [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can access the workspace ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)). enum: - personal - team - private - public - partner example: team getWorkspacesScimObject: type: object description: An object containing SCIM user IDs. This object only returns if you pass the `include=scim` query parameter. properties: createdBy: type: string description: The SCIM user ID of the user who created the workspace. example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 getWorkspacesWorkspaceData: type: object description: Information about the workspace. properties: id: type: string description: The workspace's ID. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: type: string description: The workspace's name. example: Team Workspace type: $ref: '#/components/schemas/workspaceType' visibility: $ref: '#/components/schemas/workspaceVisibility' createdBy: type: string description: The user who created the workspace. The response only returns workspaces that you have access to. example: '12345678' about: type: string description: A brief summary about the workspace. example: This is a team workspace. createdAt: type: string format: date-time description: The date and time at which the workspace was created. example: '2022-07-18T06:57:37.000Z' updatedAt: type: string format: date-time description: The date and time at which the workspace was last updated. example: '2025-05-30T08:49:54.000Z' scim: $ref: '#/components/schemas/getWorkspacesScimObject' getWorkspaces: title: Successful Response type: object properties: workspaces: type: array description: A list of workspaces. items: $ref: '#/components/schemas/getWorkspacesWorkspaceData' meta: type: object description: The response's meta information for paginated results. This object only returns if you pass the `limit` query parameter. properties: nextCursor: type: string description: The pagination cursor that points to the next record in the results set. example: NDgzMjY1 workspace400Error: title: Bad Request type: object properties: error: type: object description: Information about the error. properties: name: type: string description: The error name. example: invalidParamError message: type: string description: The error message. example: visibilityStatus must be one of personal/private/team/public/partner statusCode: type: integer format: http-status-code description: The error's HTTP status code. example: 400 commonErrorNameMessageOnly: title: Error (Name, Message) type: object properties: name: type: string description: The error name. example: badRequest message: type: string description: The error message. example: Invalid request commonErrorErrorMessage: title: Error (Error, Message) type: object properties: error: type: string description: The error type. example: rateLimited message: type: string description: The error message. example: Rate limit exceeded. Please retry after 1669048687 createWorkspaceData: type: object description: Information about the workspace. required: - name - type properties: name: type: string description: The workspace's name. example: Team Workspace type: type: string description: | The type of workspace: - `personal` - `private` — Private workspaces are available on Postman [**Team** and **Enterprise** plans](https://www.postman.com/pricing). - `public` - `team` - `partner` — [Partner Workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) are available on Postman [**Team** and **Enterprise** plans](https://www.postman.com/pricing)). enum: - personal - private - public - team - partner example: team description: type: string description: The workspace's description. example: This is a team workspace. about: type: string description: A brief summary about the workspace. example: This is a team workspace. teamId: type: string description: The team ID to assign to the workspace. This property is required if Postman [Organizations](https://learning.postman.com/docs/administration/managing-your-team/overview) is enabled. example: '123' createWorkspace: title: Create Workspace type: object properties: workspace: $ref: '#/components/schemas/createWorkspaceData' createWorkspaceResponse: title: Successful Response type: object properties: workspace: type: object description: Information about the created workspace. properties: id: type: string description: The workspace's ID. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: type: string description: The workspace's name. example: Test Workspace workspace403Error: title: Forbidden type: object properties: error: type: object description: Information about the error. properties: status: type: number format: http-status-code description: The error's HTTP status code. example: 403 name: type: string description: The error name. example: forbiddenError message: type: string description: The error message. example: You are not authorized to perform this action detail: type: string description: Information about the error. example: You do not have permission to create team workspaces. instance: type: string description: The URI reference that identifies the specific occurrence of the problem. example: '' workspaceRoleData: type: object description: Information about the role. properties: id: type: string description: The role's ID. example: '1' description: type: string description: The role's description. example: Can view and collaborate on all resources displayName: type: string description: The role's display name. example: Viewer getAllWorkspaceRoles: title: Successful Response type: object properties: roles: type: object description: Information about the workspace's roles. properties: user: type: array description: The list of user roles in the workspace. items: $ref: '#/components/schemas/workspaceRoleData' usergroup: type: array description: The list of user group roles in the workspace. items: $ref: '#/components/schemas/workspaceRoleData' partner: type: array description: The list of partner in the workspace. items: $ref: '#/components/schemas/workspaceRoleData' workspaceIncludeQuery: type: string pattern: ^(?!.*(?:^|,)(team|scim|mocks:deactivated),(?:.*,)?\1(?:$|,))(team|scim|mocks:deactivated)(,(team|scim|mocks:deactivated))*$ example: team,scim workspaceCollectionsData: type: object description: Information about the collection. properties: id: type: string description: The collection's ID. example: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: type: string description: The collection's name. example: Test Collection uid: type: string format: uid description: The collection's unique ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 workspaceEnvironmentsData: type: object description: Information about the environment. properties: id: type: string description: The environment's ID. example: 5daabc50-8451-43f6-922d-96b403b4f28e name: type: string description: The environment's name. example: Test Environment uid: type: string format: uid description: The environment's unique ID. example: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e workspaceMocksData: type: object description: Information about the mock server. properties: id: type: string description: The mock server's ID. example: e3d951bf-873f-49ac-a658-b2dcb91d3289 name: type: string description: The mock server's name. example: Test Mock uid: type: string format: uid description: The mock server's unique ID. example: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289 deactivated: type: boolean description: If true, the mock server is not active. Mock servers deactivate when a linked collection or environment is deleted. example: false workspaceMonitorsData: type: object description: Information about the monitor. properties: id: type: string description: The monitor's ID. example: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: type: string description: The monitor's name. example: Test Environment uid: type: string format: uid description: The monitor's unique ID. example: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 deactivated: type: boolean description: If true, the monitor is not active. example: false workspaceSpecsData: type: object description: Information about the API specification. properties: id: type: string description: The API specification's ID. example: 387c2863-6ee3-4a56-8210-225f774edade name: type: string description: The API specification's name. example: Test API uid: type: string format: uid description: The API specification's unique ID. example: 12345678-73e15000-bc7a-4802-b80e-05fff18fd7f8 workspaceScimData: type: object description: An object containing SCIM user IDs. This object only returns if you pass the `include=scim` query parameter. properties: createdBy: type: string description: The SCIM user ID of the user who created the workspace. example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 updatedBy: type: string description: The SCIM user ID of the user who last updated the workspace. example: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 getWorkspaceData: type: object description: Information about the workspace. properties: id: type: string description: The workspace's ID. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: type: string description: The workspace's name. example: Team Workspace type: $ref: '#/components/schemas/workspaceType' description: type: string description: The workspace's description. example: This is a team workspace. visibility: $ref: '#/components/schemas/workspaceVisibility' createdBy: type: string description: The user ID of the user who created the workspace. example: '12345678' updatedBy: type: string description: The user ID of the user who last updated the workspace. example: '12345678' createdAt: type: string format: date-time description: The date and time at which the workspace was created. example: '2022-07-06T16:18:32.000Z' updatedAt: type: string format: date-time description: The date and time at which the workspace was last updated. example: '2022-07-06T20:55:13.000Z' about: type: string description: A brief summary about the workspace. example: This is a team workspace. team: type: string description: The workspace's team ID. example: '1' collections: type: array description: A list of the workspace's collections. items: $ref: '#/components/schemas/workspaceCollectionsData' environments: type: array description: A list of the workspace's environments. items: $ref: '#/components/schemas/workspaceEnvironmentsData' mocks: type: array description: A list of the workspace's mock servers. items: $ref: '#/components/schemas/workspaceMocksData' monitors: type: array description: A list of the workspace's monitors. items: $ref: '#/components/schemas/workspaceMonitorsData' specs: type: array description: A list of the workspace's API specifications. items: $ref: '#/components/schemas/workspaceSpecsData' scim: $ref: '#/components/schemas/workspaceScimData' getWorkspace: title: Successful Response type: object properties: workspace: $ref: '#/components/schemas/getWorkspaceData' workspace404Error: title: Not Found type: object properties: error: type: object description: Information about the error. properties: name: type: string description: The error name. example: workspaceNotFoundError message: type: string description: The error message. example: Workspace not found statusCode: type: number format: http-status-code description: The error's HTTP status code. example: 404 updateWorkspaceData: type: object properties: name: type: string description: The workspace's new name. example: Test Workspace type: type: string description: | The new workspace visibility [type](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility). 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](https://www.postman.com/pricing/). - `public` to `personal` for team users. enum: - private - personal - team - public example: team description: type: string description: The new workspace description. example: This is a test team workspace. about: type: string description: A brief summary about the workspace. example: This is a team workspace. updateWorkspace: title: Update Workspace type: object properties: workspace: description: The workspace fields to update. allOf: - $ref: '#/components/schemas/updateWorkspaceData' updateWorkspaceResponse: title: Workspace Updated type: object properties: workspace: type: object description: Information about the updated workspace. properties: id: type: string description: The workspace's ID. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: type: string description: The workspace's name. example: Test Workspace deleteWorkspace: title: Workspace Deleted type: object properties: workspace: type: object description: Information about the deleted workspace. properties: id: type: string description: The workspace's ID. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 userId-2: type: integer nullable: true example: 12345678 elementType-3: type: string nullable: true enum: - collection - workspace - environment - mock - monitor example: collection limitDefault15: type: integer default: 15 example: 10 getWorkspaceActivityFeedUserData: type: object description: Information about the user that performed the activity. properties: id: type: integer description: The user's ID. example: 12345678 username: type: string description: The user's Postman username. example: research-physicist-12345678 isPartner: type: boolean description: If true, the user is a [Partner](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#partner-team-and-partner-workspace-roles) in the workspace. example: false name: type: string description: The user's name. example: Taylor Lee getWorkspaceActivityFeed: title: Workspace Activity Feed type: object properties: data: type: array description: A list of the workspace's activity entries. items: type: object description: Information about the workspace's activity. properties: workspaceId: type: string description: The workspace's ID. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdAt: type: string format: date-time description: The date and time at which the element was created. example: '2025-04-07T13:59:02Z' updatedAt: type: string format: date-time description: The date and time at which the element was updated. example: '2025-04-07T13:59:02Z' id: type: integer description: The activity feed's ID. example: 15131 user: $ref: '#/components/schemas/getWorkspaceActivityFeedUserData' action: type: string description: The action that occurred in the workspace. enum: - create - update - destroy example: update elementType: type: string description: The element type. example: workspace trigger: type: string description: The trigger that caused the workspace action (`create`, `update`, or `destroy`). example: update_visibility elementId: type: string description: The element's ID. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 elementName: type: string description: The element's name. example: Testing APIs meta: $ref: '#/components/schemas/meta' transferWorkspaceElement: type: object required: - id - type - to properties: id: anyOf: - type: string format: uid title: Element Unique ID - type: string title: Element ID description: The workspace element's ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 type: type: string description: The type of element to transfer. enum: - collection - environment - api - flow - mock - monitor example: collection to: type: string description: The workspace ID to transfer the element into. example: d56bc95f-57c5-47cc-bd99-75c4ad96a6dd transferWorkspaceElementResponse: type: object properties: workspace: type: object description: Information about the workspace that received the transferred element. properties: element-transfers: type: object description: Information about the element transfer. properties: type: type: string description: The type of element transferred. example: collection from: type: string description: The ID of the workspace the element was transferred from. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 id: type: string description: The element's ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 to: type: string description: The ID of the workspace the element was transferred to. example: d56bc95f-57c5-47cc-bd99-75c4ad96a6dd globalVariable: title: Global Variable Info type: object description: Information about the global variable. properties: key: type: string description: The variable's name. example: collectionId type: type: string description: The [type](https://learning.postman.com/docs/sending-requests/variables/#variable-types) of variable. enum: - default - secret example: default value: type: string description: The variable's value. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 enabled: type: boolean description: If true, the variable is enabled. example: true description: type: string maxLength: 512 description: The variable's description. example: The collection's ID. getWorkspaceGlobalVariables: title: Successful Response type: object description: Information about the workspace's global variables. properties: values: type: array description: A list of the workspace's global variables. items: $ref: '#/components/schemas/globalVariable' updateWorkspaceGlobalVariables: title: Update Global Variables type: object properties: values: type: array description: A list of the workspace's global variables. items: $ref: '#/components/schemas/globalVariable' updateWorkspaceGlobalVariablesResponse: title: Global Variables Updated type: object description: Information about the workspace's updated global variables. properties: values: type: array description: A list of the workspace's global variables. items: $ref: '#/components/schemas/globalVariable' workspaceIncludeScimQuery: type: string example: scim enum: - scim workspaceRolesData: type: object properties: id: type: string description: The role's ID. example: '3' user: type: array description: A list of user IDs assigned to the role. items: type: string description: The user's ID or SCIM ID. example: '12345678' usergroup: type: array description: A list of user group IDs assigned to the role. items: type: string description: The group's ID or SCIM ID. example: '123' partner: type: array description: A list of partner IDs assigned to the role. items: type: string description: The partner's ID. example: '43215678' displayName: type: string description: The role's display name. example: Viewer getWorkspaceRoles: title: Workspace Roles type: object description: Information about the workspace's roles. properties: roles: type: array description: A list of workspace roles and the users, groups, and partners assigned to them. items: $ref: '#/components/schemas/workspaceRolesData' updateWorkspaceRoles: title: Update Workspace Roles type: object properties: roles: type: array description: A list of role update operations to apply to the workspace. items: type: object required: - op - path - value properties: op: type: string description: The operation to perform on the path. example: add path: type: string description: The resource to perform the action on. enum: - /user - /usergroup - /partner example: /user value: type: array description: Information about the updated workspace role. items: type: object description: Information about the user, user group, or partner role. required: - id - role properties: id: type: string description: The user, user group, or partner's ID. To use SCIM IDs for users or user groups, include the `identifierType=scim` header in the request. example: '12345678' role: type: string description: | The user or user group's role ID: - `1` — Viewer. Can view and collaborate on all resources. - `2` — Editor. Can create and edit all resources. - `3` — Admin. Can manage people and all resources. For partner roles: - `4` — Viewer. Can send requests and view workspace resources. - `5` — Editor. Can create, edit and fork workspace resources. - `6` — Viewer and Partner Lead. Can view, fork and export workspace resources, and invite partners. - `7` — Editor and Partner Lead. Can create and edit workspace resources, and invite partners with Editor or Viewer access to the workspace. example: '1' updateWorkspaceRolesData: type: object properties: id: type: string description: The role's ID. example: '1' user: type: array description: A list of user IDs assigned to the role. items: type: string description: The user's ID or SCIM ID. example: '12345678' group: type: array description: A list of user group IDs assigned to the role. items: type: string description: The user group's ID or SCIM ID. example: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00 displayName: type: string description: The role's display name. example: Viewer updateWorkspaceRolesResponse: title: Workspace Roles Updated type: object properties: roles: type: array description: A list of the role update operations that were applied to the workspace. items: $ref: '#/components/schemas/updateWorkspaceRolesData' workspaceRoles422Error: title: Partner and Personal Workspace Roles Unsupported type: object properties: detail: type: string description: Information about the error. example: Roles are not supported for personal and partner workspaces. link: type: string description: The error type. example: https://api.postman.com/problems/unprocessable-entity status: type: number format: http-status-code description: The error's HTTP status code. example: 422 title: type: string description: A short summary of the problem. example: Cannot process the request. transferWorkspaceToTeam: type: object required: - source - destination properties: destination: type: string description: The ID of the team to transfer the workspace to. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 source: type: string description: The ID of the team to transfer the workspace from. example: d56bc95f-57c5-47cc-bd99-75c4ad96a6dd transferWorkspaceToTeamResponseObject: type: object description: Information about the workspace transfer. properties: id: type: string description: The ID of the transferred workspace. example: 8b6ea58b-fd33-4678-bdab-67734b3ed6b0 source: type: string description: The ID of the team the workspace was transferred away from. example: d56bc95f-57c5-47cc-bd99-75c4ad96a6dd destination: type: string description: The ID of the team that the workspace was transferred to. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 transferWorkspaceToTeamResponse: type: object properties: workspace: type: object description: Information about the transferred workspace. properties: transfer: $ref: '#/components/schemas/transferWorkspaceToTeamResponseObject' workspaceUpdateCategory: type: string example: improvement,announcement workspaceUpdateCreatedByData: type: object description: Information about the user that created the workspace update. properties: id: type: integer description: The user ID of the user that created the workspace update. example: 12345678 name: type: string description: The display name of the user that created the workspace update. example: Taylor Lee username: type: string description: The username of the user that created the workspace update. example: taylor-lee workspaceUpdateCategoryData: type: string description: The update's assigned category. enum: - improvement - new_feature - bug_fix - breaking_change - announcement example: improvement workspaceUpdateRelatedResourcesData: type: array description: A list containing the update's related elements. Related elements include links to collections, requests, folders, and saved examples in the update. maxItems: 10 items: type: object required: - resource - resourceId properties: resource: type: string description: The type of linked resource. enum: - collection - request - response - folder - extensibleCollection - extensibleCollectionItem example: collection resourceId: type: string description: The linked resource's ID. example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 workspaceUpdateData: title: Workspace Update Data type: object description: Information about the workspace update. properties: id: type: integer description: The workspace update's ID. example: 123 topic: type: string description: The title of the workspace update. example: API v1.0 released description: type: string description: The content of the workspace update. example: We have released a new version of the API with several improvements. workspaceId: type: string description: The ID of the workspace in which the workspace update was created. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdBy: $ref: '#/components/schemas/workspaceUpdateCreatedByData' updatedBy: type: integer description: The ID of the user who last updated the workspace update. example: 12345678 createdAt: type: string format: date-time description: The date and time at which the workspace update was created. example: '2026-04-21T04:02:20.000Z' updatedAt: type: string format: date-time description: The date and time at which the workspace update was last updated. example: '2026-04-10T11:58:43.000Z' category: $ref: '#/components/schemas/workspaceUpdateCategoryData' isPinned: type: boolean default: false description: If true, the workspace update is pinned to the top of the workspace updates list. example: false relatedResources: $ref: '#/components/schemas/workspaceUpdateRelatedResourcesData' getWorkspaceUpdates: type: object properties: data: type: array description: A list of workspace updates. items: $ref: '#/components/schemas/workspaceUpdateData' meta: $ref: '#/components/schemas/meta' createWorkspaceUpdate: title: Create Workspace Update type: object required: - description - topic - category properties: description: type: string minLength: 1 maxLength: 20000 description: The content of the workspace update. example: We've released the first version of our newest API! topic: type: string minLength: 1 maxLength: 255 description: The title of the workspace update. example: API v1.0 released category: $ref: '#/components/schemas/workspaceUpdateCategoryData' relatedResources: $ref: '#/components/schemas/workspaceUpdateRelatedResourcesData' workspaceUpdatePostPatchResponseData: type: object properties: id: type: integer description: The workspace update's ID. example: 123 topic: type: string description: The title of the workspace update. example: API v1.0 released description: type: string description: The content of the workspace update. example: We've released the first version of our newest API! workspaceId: type: string description: The ID of the workspace in which the workspace update was created. example: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdBy: type: integer description: The user ID of the user that created the workspace update. example: 12345678 updatedBy: type: integer description: The ID of the user who last updated the workspace update. example: 12345678 createdAt: type: string format: date-time description: The date and time at which the workspace update was created. example: '2026-04-21T04:02:20.000Z' updatedAt: type: string format: date-time description: The date and time at which the workspace update was last updated. example: '2026-04-10T11:58:43.000Z' category: $ref: '#/components/schemas/workspaceUpdateCategoryData' isPinned: type: boolean default: false description: If true, the workspace update is pinned to the top of the workspace updates list. example: false relatedResources: $ref: '#/components/schemas/workspaceUpdateRelatedResourcesData' workspaceUpdateId: type: integer example: 123 contentTypeMerge-PatchHeader: type: string enum: - application/merge-patch+json example: application/merge-patch+json updateWorkspaceUpdate: title: Update Workspace Update type: object required: - description - topic - category properties: description: type: string minLength: 1 maxLength: 20000 description: The content of the workspace update. example: We've released the first version of our newest API! topic: type: string minLength: 1 maxLength: 255 description: The title of the workspace update. example: API v1.0 released category: $ref: '#/components/schemas/workspaceUpdateCategoryData' isPinned: type: boolean default: false description: If true, the workspace update is pinned to the top of the workspace updates list. example: true relatedResources: $ref: '#/components/schemas/workspaceUpdateRelatedResourcesData' examples: getAccounts: value: billingEmail: taylor.lee@example.com id: 372691 salesChannel: SELF_SERVE slots: available: 8 consumed: 2 total: 10 unbilled: 0 state: PAID teamId: 380691 invoices400ErrorNotPartOfTeam: value: type: https://api.postman.com/problems/bad-request title: Malformed request status: 400 detail: You must be part of a team invoices400ErrorBadRequest: value: type: https://api.postman.com/problems/bad-request title: Malformed request status: 400 detail: Please provide a valid status to fetch invoices common401Error: value: type: https://api.postman.com/problems/unauthorized title: Unauthorized detail: Unauthorized status: 401 common401ErrorAuthentication: value: error: name: AuthenticationError message: Invalid API Key. Every request requires a valid API Key to be sent. common401ErrorInvalidApiKey: value: type: https://api.postman.com/problems/unauthorized title: Unauthorized status: 401 detail: A valid API key must be provided in the request header. common401ErrorMissingApiKey: value: type: https://api.postman.com/problems/unauthorized title: Unauthorized detail: An API key must be provided in the request header or query string status: 401 common401ErrorNotAuthorized: value: type: https://api.postman.com/problems/unauthorized title: Unauthorized detail: You are not authorized to perform this action. status: 401 common500ErrorInternalServer: value: type: https://api.postman.com/problems/internal-server-error title: Internal Server Error status: 500 detail: Internal Server Error common500ErrorDetail: value: type: https://api.postman.com/problems/internal-server-error title: Internal Server Error detail: Internal Server Error common500ErrorServerError: value: error: name: serverError message: An error has occurred on the server. common500ErrorSomethingWrong: value: type: https://api.postman.com/problems/internal-server-error title: Something went wrong detail: Something went wrong status: 500 common500ErrorSomethingWrongContactSupport: value: type: https://api.postman.com/problems/internal-server-error title: Something went wrong status: 500 detail: Something went wrong. Please contact support. getAccountInvoicesSuccessfulResponse: value: data: - id: inv_7UDSYBJPGQU93N7M status: PAID issuedAt: '2023-10-12' totalAmount: value: 440 currency: USD links: web: href: https://pay.postman.com/invoices/pay?invoice_public_id=inv_7UDSYBJPGQU93N7M getAccountInvoicesNoInvoices: value: data: [] invoices403ErrorForbidden: value: type: https://api.postman.com/problems/forbidden title: Forbidden status: 403 detail: You are not authorized to perform this action invoices403ErrorInvalidAccountId: value: type: https://api.postman.com/problems/forbidden title: Forbidden status: 403 detail: Could not fetch invoices for the team. getAnalyticsDataUsersActiveUsersTop5Users: value: data: summary: pagination: limit: 5 offset: 0 total: 573 has_more: true schema: columns: - type: STRING description: Unique identifier assigned to the user. name: user_id - type: DATE description: Date when the user joined the team. name: team_joining_date - type: TIMESTAMP format: YYYY-MM-DDTHH:MM:SSZ description: Timestamp of the user's most recent activity. name: last_active_ts - type: INTEGER description: Total number of API requests made by the user. name: api_requests_count - type: INTEGER description: Total number of system actions made by the user. name: system_actions_count - type: STRING description: Primary tasks made by the user. name: primary_tasks rows: - - '55894978' - '2026-06-14' - '2026-07-25' - 21 - 11 - Development, Testing - - '10009000' - '2020-01-08' - '2026-07-28' - 0 - 173 - Development - - '10020575' - '2020-01-09' - '2026-07-23' - 0 - 25 - Development, API Management - - '10102115' - '2020-01-16' - '2026-07-27' - 0 - 1 - API Management - - '10497157' - '2020-02-25' - '2026-07-28' - 0 - 42 - Development, API Management getAnalyticsDataUsersActiveUsersCountTrend: value: data: summary: rows: - - 360 - 800 - increase schema: columns: - type: INTEGER name: count description: Total number of active users. - type: FLOAT name: change description: Percentage change from the previous period. - type: STRING name: change_type description: Indicates whether the change is an increase or decrease. getAnalyticsDataWorkspaceActiveUsersCountInternalWorkspace: value: data: summary: rows: - - 149 schema: columns: - description: Total number for the summarized metric. name: count type: INTEGER getAnalyticsDataWorkspaceElements: value: data: summary: schema: columns: - name: timestamp type: DATE format: YYYY-MM-DD description: Reporting date for the aggregated metrics. - name: collections_count type: INTEGER description: Total number of collections at the given time. - name: environments_count type: INTEGER description: Total number of environments at the given time. - name: mocks_count type: INTEGER description: Total number of mock servers at the given time. - name: monitors_count type: INTEGER description: Total number of monitors at the given time. - name: flows_count type: INTEGER description: Total number of flows created at the given time. rows: - - '2025-03-01' - 420 - 310 - 150 - 190 - 120 - - '2025-04-01' - 450 - 320 - 160 - 200 - 125 - - '2025-05-01' - 470 - 335 - 170 - 215 - 130 - - '2025-06-01' - 500 - 345 - 185 - 230 - 140 - - '2025-07-01' - 520 - 355 - 195 - 240 - 145 - - '2025-08-01' - 540 - 370 - 205 - 255 - 150 getAnalyticsDataWorkspaceElementsInternalWorkspaces: value: data: summary: schema: columns: - name: timestamp type: DATE format: YYYY-MM-DD description: Reporting date for the aggregated metrics. - name: collections_count type: INTEGER description: Total number of collections at the given time. - name: environments_count type: INTEGER description: Total number of environments at the given time. - name: mocks_count type: INTEGER description: Total number of mock servers at the given time. - name: monitors_count type: INTEGER description: Total number of monitors at the given time. - name: flows_count type: INTEGER description: Total number of flows created at the given time. rows: - - '2025-03-01' - 420 - 310 - 150 - 190 - 120 - - '2025-04-01' - 450 - 320 - 160 - 200 - 125 - - '2025-05-01' - 470 - 335 - 170 - 215 - 130 - - '2025-06-01' - 500 - 345 - 185 - 230 - 140 - - '2025-07-01' - 520 - 355 - 195 - 240 - 145 - - '2025-08-01' - 540 - 370 - 205 - 255 - 150 getAnalyticsDataWorkspaceActiveWorkspace: value: data: summary: schema: columns: - description: Indicates whether the workspace is hidden. name: is_hidden type: BOOLEAN - description: Unique identifier of the workspace. name: workspace_id type: STRING - description: Display name of the workspace. name: workspace_name type: STRING - description: Name of the user who created the workspace. name: created_by type: STRING - description: Category of the workspace such as internal or partner. name: type type: STRING - description: Number of contributors in the workspace. name: contributors type: INTEGER - description: Total number of API calls made within the workspace. name: api_calls type: INTEGER pagination: total: 238 has_more: true offset: 0 limit: 5 rows: - - true - 2792cd99-7c05-43fa-90ad-5e2bf098ae14 - null - '12345678' - internal - 1 - 56 - - true - e7c2871e-c9cc-4e39-a541-41bfdebbea7f - null - '12345678' - internal - 0 - 32 - - true - 6e97104e-01cd-4ae0-991e-6a7905f6252d - null - '56781234' - internal - 3 - 32 - - false - 36c18c9f-e942-4119-bef8-2cf0ebede4e9 - User Authentication API - '12345678' - internal - 2 - 95 - - false - 66764399-25d0-4dc5-9e9d-30a433c1df63 - Performance Monitors - '56781234' - internal - 0 - 15 getAnalyticsDataWorkspaceActiveWorkspacesInternalWorkspaces: value: data: summary: rows: - - true - 2792cd99-7c05-43fa-90ad-5e2bf098ae14 - null - '12345678' - internal - 1 - 56 - - true - e7c2871e-c9cc-4e39-a541-41bfdebbea7f - null - '12345678' - internal - 0 - 32 - - true - 6e97104e-01cd-4ae0-991e-6a7905f6252d - null - '56781234' - internal - 1 - 32 pagination: total: 214 has_more: true offset: 0 limit: 3 schema: columns: - description: Indicates whether the workspace is hidden. name: is_hidden type: BOOLEAN - description: Unique identifier of the workspace. name: workspace_id type: STRING - description: Display name of the workspace. name: workspace_name type: STRING - description: Name of the user who created the workspace. name: created_by type: STRING - description: Category of the workspace such as internal or partner. name: type type: STRING - description: Number of contributors in the workspace. name: contributors type: INTEGER - description: Total number of API calls made within the workspace. name: api_calls type: INTEGER getAnalyticsDataWorkspaceActiveCountTrend: value: data: summary: rows: - - 312 - 4.69 - increase schema: columns: - description: Total number for the summarized metric. name: count type: INTEGER - description: Percentage or numeric change from the previous value. name: change type: FLOAT - description: Indicates whether the change is an increase or decrease. name: change_type type: STRING getAnalyticsDataWorkspaceActiveCountTrendInternalWorkspace: value: data: summary: rows: - - 312 - 4.69 - increase schema: columns: - description: Total number for the summarized metric. name: count type: INTEGER - description: Percentage or numeric change from the previous value. name: change type: FLOAT - description: Indicates whether the change is an increase or decrease. name: change_type type: STRING getAnalyticsDataWorkspaceActiveUsersCountInternalWorkspace2: value: data: summary: rows: - - 149 schema: columns: - type: INTEGER name: count description: Total number for the summarized metric. getAnalyticsDataWorkspaceAPICallsCountTrend: value: data: summary: rows: - - 120546 - 3.74 - increase schema: columns: - type: INTEGER name: count description: Total number for the summarized metric. - type: FLOAT name: change description: Percentage or numeric change from the previous value. - type: STRING name: change_type description: Indicates whether the change is an increase or decrease. getAnalyticsDataWorkspaceAPICallsCountTrendInternalWorkspace: value: data: summary: rows: - - 120546 - 3.74 - increase schema: columns: - type: INTEGER name: count description: Total number for the summarized metric. - type: FLOAT name: change description: Percentage or numeric change from the previous value. - type: STRING name: change_type description: Indicates whether the change is an increase or decrease. getAnalyticsDataWorkspaceActiveCollections: value: data: summary: pagination: total: 38 limit: 3 offset: 0 has_more: true schema: columns: - type: BOOLEAN name: is_hidden description: Indicates whether the collection is hidden. - type: STRING name: collection_id description: Unique identifier of the collection. - type: STRING name: collection_name description: Display name of the collection. - type: STRING name: workspace_name description: Name of the workspace containing the collection. - type: STRING name: created_by description: Unique identifier assigned to the user. - type: INTEGER name: api_calls_count description: Total number of API calls made using requests in this collection. rows: - - false - 12345678-f5c93a94-8981-4005-a75a-a02d5a4e5235 - Service Monitoring API - Engineering Hub - '12345678' - 152 - - false - 975a340d-5911-486c-8382-8d952ac4f336 - Import Tools - Gateway Tools - '12345678' - 100 - - false - 36c18c9f-e942-4119-bef8-2cf0ebede4e9 - User Authentication API - Partner API Hub - '12345678' - 95 getAnalyticsDataWorkspaceActiveCollectionsInternalWorkspaces: value: data: summary: pagination: total: 38 limit: 3 offset: 0 has_more: true schema: columns: - description: Indicates whether the collection is hidden. name: is_hidden type: BOOLEAN - description: Unique identifier of the collection. name: collection_id type: STRING - description: Display name of the collection. name: collection_name type: STRING - description: Name of the workspace containing the collection. name: workspace_name type: STRING - description: Unique identifier assigned to the user. name: created_by type: STRING - description: Total number of API calls made using requests in this collection. name: api_calls_count type: INTEGER rows: - - false - 56781234-dd14b810-bb36-4549-9410-1c30728fb417 - Service Monitoring API - Engineering Hub - '56781234' - 39 - - false - 56781234-dd14b810-bb36-4549-9410-1c30728fb417 - Service Monitoring API - Engineering Hub - '56781234' - 109 - - false - 12345678-975a340d-5911-486c-8382-8d952ac4f336 - Import Tools - Gateway Tools - '12345678' - 29 getAnalyticsDataWorkspaceResponseStatusTrend: value: data: summary: schema: columns: - name: timestamp type: DATE format: YYYY-MM-DD description: Reporting date for the aggregated API metrics. - name: total_count type: INTEGER description: Total number of API requests for the given date. - name: count_2xx type: INTEGER description: Number of successful API responses (2xx). - name: count_3xx type: INTEGER description: Number of redirection responses (3xx). - name: count_4xx type: INTEGER description: Number of client error responses (4xx). - name: count_5xx type: INTEGER description: Number of server error responses (5xx). rows: - - '2025-03-01' - 102340 - 74480 - 3120 - 23100 - 4760 - - '2025-04-01' - 110540 - 80210 - 2990 - 25340 - 4990 - - '2025-05-01' - 125780 - 92410 - 3200 - 28200 - 5170 - - '2025-06-01' - 118420 - 86540 - 3030 - 27050 - 4830 - - '2025-07-01' - 121360 - 88250 - 3300 - 28210 - 4900 - - '2025-08-01' - 130550 - 95400 - 3530 - 29620 - 5530 getAnalyticsDataWorkspaceResponseStatusTrendInternalWS: value: data: summary: schema: columns: - name: timestamp type: DATE format: YYYY-MM-DD description: Reporting date for the aggregated API metrics. - name: total_count type: INTEGER description: Total number of API requests for the given date. - name: count_2xx type: INTEGER description: Number of successful API responses (2xx). - name: count_3xx type: INTEGER description: Number of redirection responses (3xx). - name: count_4xx type: INTEGER description: Number of client error responses (4xx). - name: count_5xx type: INTEGER description: Number of server error responses (5xx). rows: - - '2025-03-01' - 102340 - 74480 - 3120 - 23100 - 4760 - - '2025-04-01' - 110540 - 80210 - 2990 - 25340 - 4990 - - '2025-05-01' - 125780 - 92410 - 3200 - 28200 - 5170 - - '2025-06-01' - 118420 - 86540 - 3030 - 27050 - 4830 - - '2025-07-01' - 121360 - 88250 - 3300 - 28210 - 4900 - - '2025-08-01' - 130550 - 95400 - 3530 - 29620 - 5530 getAnalyticsDataWorkspaceCollectionErrorRate: value: data: summary: schema: columns: - name: is_hidden type: BOOLEAN description: Indicates whether the collection is hidden. - name: collection_id type: STRING description: Unique identifier of the collection. - name: collection_name type: STRING description: Name of the collection. - name: workspace_id type: STRING description: Unique identifier of the workspace owning the collection. - name: count_4xx type: INTEGER description: Total number of 4xx responses for the collection in the selected duration. - name: count_5xx type: INTEGER description: Total number of 5xx responses for the collection in the selected duration. - name: total_api_calls type: INTEGER description: Total API calls for the collection in the selected duration. rows: - - 56781234-dd14b810-bb36-4549-9410-1c30728fb417 - Demo requests - ca858e90-131c-44a1-a132-03903fb1ab35 - 0 - 0 - 1 - - 12345678-36c18c9f-e942-4119-bef8-2cf0ebede4e9 - Testing composasble - 4540d410-ef72-4977-afb8-d7f53705f379 - 0 - 0 - 1 - - 87654321-13f603d8-4cb2-45d1-92f8-e39891fdf387 - New Collection - b63a8c9d-fac3-47b9-85b1-7ba9237ce62f - 0 - 0 - 1 pagination: total: 453 limit: 3 offset: 0 has_more: true getAnalyticsDataTeamUserAPIJourneyTrend: value: data: summary: schema: columns: - name: timestamp type: DATE format: YYYY-MM-DD description: Reporting date for aggregated user activity metrics. - name: active_user type: INTEGER description: Total number of users active on the given date. - name: api_user type: INTEGER description: Number of users who made at least one API call. - name: new_api_user type: INTEGER description: Number of users making API calls for the first time. - name: successful type: INTEGER description: Number of users whose API calls were mostly successful. - name: error_only type: INTEGER description: Number of users who encountered only error responses. rows: - - '2025-03-01' - 812 - 654 - 120 - 590 - 64 - - '2025-04-01' - 920 - 710 - 145 - 620 - 90 - - '2025-05-01' - 845 - 692 - 100 - 640 - 52 - - '2025-06-01' - 900 - 730 - 130 - 670 - 60 - - '2025-07-01' - 870 - 710 - 110 - 660 - 50 - - '2025-08-01' - 890 - 740 - 140 - 690 - 50 getAnalyticsDataTeamWorkspaceDistributionTrend: value: data: summary: schema: columns: - name: date type: DATE format: YYYY-MM-DD description: Reporting date for the aggregated workspace counts. - name: total type: INTEGER description: Total number of workspaces for the given date. - name: internal type: INTEGER description: Number of internal workspaces. - name: partner type: INTEGER description: Number of partner workspaces. - name: public type: INTEGER description: Number of public workspaces. rows: - - '2025-02-01' - 1300 - 950 - 200 - 150 - - '2025-03-01' - 1350 - 980 - 210 - 160 - - '2025-04-01' - 1370 - 995 - 215 - 160 - - '2025-05-01' - 1380 - 1000 - 220 - 160 - - '2025-06-01' - 1400 - 1020 - 225 - 155 - - '2025-07-01' - 1420 - 1035 - 230 - 155 getAnalyticsDataTeamInternalWorkspaceDistributionTrend: value: data: summary: schema: columns: - name: date type: DATE format: YYYY-MM-DD description: Reporting date for internal workspace distribution. - name: internal_team_shared type: INTEGER description: Count of internal team-shared workspaces. - name: internal_private type: INTEGER description: Count of internal private workspaces. rows: - - '2025-02-01' - 520 - 380 - - '2025-03-01' - 540 - 395 - - '2025-04-01' - 555 - 405 - - '2025-05-01' - 565 - 415 - - '2025-06-01' - 575 - 425 - - '2025-07-01' - 590 - 440 getAnalyticsDataTeamLicenseConsumptionTrend: value: data: summary: schema: columns: - name: date type: DATE format: YYYY-MM-DD description: Reporting date for team and license metrics. - name: team_members type: INTEGER description: Total number of members in the team. - name: active_postman_users type: INTEGER description: Count of team members actively using Postman. - name: partners type: INTEGER description: Number of partner users associated with the team. - name: guests type: INTEGER description: Number of guest users with limited access. - name: unused_licenses type: INTEGER description: Number of licenses assigned but not actively used. rows: - - '2025-02-01' - 600 - 430 - 170 - 85 - 25 - - '2025-03-01' - 620 - 450 - 180 - 90 - 20 - - '2025-04-01' - 635 - 460 - 185 - 92 - 18 - - '2025-05-01' - 640 - 475 - 190 - 95 - 15 - - '2025-06-01' - 655 - 490 - 195 - 98 - 12 - - '2025-07-01' - 670 - 505 - 200 - 100 - 10 getAnalyticsDataTeamLastAutoflexCycleDetailed: value: data: summary: schema: columns: - type: STRING description: User's name. name: name - type: STRING description: Email ID of user. name: email - type: DATE description: Timestamp when user was last active. name: last_active - type: STRING description: Email ID that invited this user. name: invited_by - type: DATE description: Timestamp when user joined team. name: joined_date - type: STRING description: Concatenated list of roles that user has. name: user_role rows: - - taylor-lee - taylor.lee@example.com - '2025-05-14T00:00:00.000Z' - '' - '2024-12-20T08:37:08.000Z' - Developer - - alex-cruz - alex-cruz@example.com - '2025-10-30T00:00:00.000Z' - taylor.lee@example.com - '2025-05-13T08:30:45.000Z' - Developer pagination: limit: 2 has_more: true total: 10 offset: 3 getAnalyticsDataTeamMembersDetailed: value: data: summary: schema: columns: - type: STRING description: Username of the user. name: user_name - type: STRING description: Email ID of user. name: email - type: DATE description: Timestamp when user was added to team. name: added_in_team - type: DATE description: Timestamp when user was last active. name: last_active - type: STRING description: Concatenated list of roles that user has. name: user_role - type: STRING description: Email ID that invited this user. name: invited_by - type: STRING description: Type of invitation. name: invite_type - type: STRING description: Describes whether the public profile of the user is enabled or not. name: public_profile_enabled rows: - - taylor-lee - taylor.lee@example.com - '2025-09-02' - '2025-09-02' - Developer - '' - '' - 'Yes' - - alex-cruz - alex.cruz@example.com - '2025-09-02' - '2025-09-02' - Developer - '' - '' - 'Yes' pagination: limit: 2 has_more: true total: 10 offset: 3 getAnalyticsDataTeamMembersOvertimeTrend: value: data: summary: schema: columns: - format: YYYY-MM-DD type: DATE description: First day of the calendar month the count is aggregated for. name: month - type: INTEGER description: Total number of members on the team for that month. name: team_members rows: - - '2026-02-01' - 1339 - - '2026-03-01' - 0 getAnalyticsDataTeamMemberInvitesTrend: value: data: summary: schema: columns: - type: DATE description: First day of the calendar month the invite counts are aggregated for. name: month format: YYYY-MM-DD - type: INTEGER name: invites_sent description: Number of member invites sent during that month. - type: INTEGER name: invites_accepted description: Number of member invites accepted during that month. rows: - - '2026-01-01' - 71 - 27 - - '2026-02-01' - 84 - 51 - - '2026-03-01' - 8 - 3 - - '2026-04-01' - 0 - 0 - - '2026-05-01' - 0 - 0 - - '2026-06-01' - 0 - 0 - - '2026-07-01' - 0 - 0 getAnalyticsDataTeamMemberInvitesSentDetailed: value: data: summary: schema: columns: - type: STRING description: Email ID of the user who sent the invite. name: invited_by - type: STRING description: Type of invitation. name: invite_type - format: YYYY-MM-DDTHH:MM:SSZ type: TIMESTAMP description: Timestamp when the invite was sent. name: created_at pagination: has_more: true offset: 0 total: 84 limit: 3 rows: - - sam.taylor@example.com - Email Invite - '2026-02-27T00:00:00.000Z' - - taylor.lee@example.com - Invite Link - '2026-02-10T00:00:00.000Z' - - alex.cruz@example.com - Invite Link - '2026-02-10T00:00:00.000Z' getAnalyticsDataTeamMemberInvitesAcceptedDetailed: value: data: summary: schema: columns: - type: TIMESTAMP description: Timestamp when the invite was originally sent. name: created_at format: YYYY-MM-DDTHH:MM:SSZ - type: TIMESTAMP description: Timestamp when the invite was accepted. name: accepted_at format: YYYY-MM-DDTHH:MM:SSZ - type: STRING name: invite_type description: Type of invitation. - type: STRING name: invited_by description: Email ID of the user who sent the invite. - type: STRING name: accepted_by description: Email ID of the user who accepted the invite. pagination: limit: 3 total: 51 offset: 0 has_more: true rows: - - '2026-02-02T00:00:00.000Z' - '2026-02-02T00:00:00.000Z' - Invite Link - taylor.lee@example.com.com - taylor.lee@example.com.com - - '2026-02-05T00:00:00.000Z' - '2026-02-05T00:00:00.000Z' - Email Invite - alex.cruz@example.com - alex.cruz@example.com - - '2026-02-05T00:00:00.000Z' - '2026-02-05T00:00:00.000Z' - Email Invite - sam.taylor@example.com - sam.taylor@example.com getAnalyticsDataPartnerWorkspacePendingInvitesCount: value: data: summary: schema: columns: - name: count type: INTEGER description: Total number Pending invites. rows: - - 65 getAnalyticsDataPartnerWorkspacePendingInvites: value: data: summary: schema: columns: - name: email_id type: STRING description: Target email of pending invite - name: invite_id type: STRING description: Unique identifier for the invite - name: timestamp type: TIMESTAMP format: YYYY-MM-DDTHH:MM:SSZ description: Time when the invite was created rows: - - taylor.lee@example.com - '759126' - '2025-08-17T15:00:00Z' - - alex.cruz@example.com - '759127' - '2025-08-17T12:30:00Z' - - ava.foster@example.com - '759128' - '2025-08-16T10:45:00Z' pagination: total: 65 limit: 3 offset: 0 has_more: true getAnalyticsDataPartnerWorkspaceNeedsAttentionCount: value: data: summary: schema: columns: - name: count type: INTEGER description: Number of partners that need attention. rows: - - 65 getAnalyticsDataPartnerWorkspaceNeedsAttention: value: data: summary: schema: columns: - name: user_id type: STRING description: Unique identifier of the user. - name: request_type type: STRING description: Type of issue or request pattern detected for the user. - name: timestamp type: TIMESTAMP format: YYYY-MM-DDTHH:MM:SSZ description: Time when the request event was recorded. - name: collection_name type: STRING description: Name of the collection associated with the request, if available. - name: request_name type: STRING description: Display name of the request attempted by the user. - name: request_identifier_id type: STRING description: Unique identifier for the specific request instance. - name: partner_id type: STRING description: Identifier of the partner associated with the request, if applicable. rows: - - '12345678' - no_success_on_tried_request - '2025-08-20T14:32:00Z' - Payments Gateway API - Create Payment - 12345678-850fc79d-c756-480d-83ea-b0c05683088e - null - - '87654321' - high_non_200OK_rate_for_partner - '2025-08-20T13:50:00Z' - null - null - null - '56781234' - - '12345678' - no_success_on_tried_request - '2025-08-19T21:40:00Z' - Integration API - Rotate Integration Key - 12345678-7ac0f3bb-025b-48c4-adfa-e73bc0c00a32 - null pagination: total: 110 limit: 3 offset: 0 has_more: true getAnalyticsDataPartnerWorkspaceAPISuccessRateTrend: value: data: summary: schema: columns: - name: success_rate type: FLOAT description: Overall percentage of successful requests. - name: change type: FLOAT description: Numeric change in success rate compared to the previous period. - name: change_type type: STRING description: Indicates whether the success rate increased or decreased. rows: - - 0.962 - 0.012 - increase getAnalyticsDataPartnerWorkspaceAPISuccessRateDetailed: value: data: summary: schema: columns: - name: timestamp type: TIMESTAMP format: YYYY-MM-DDTHH:MM:SSZ description: Time when the request metrics snapshot was recorded. - name: request_identifier_id type: STRING description: Unique identifier for the specific request definition. - name: request_method type: STRING description: HTTP method used for the request. - name: request_name type: STRING description: Human-readable name of the request. - name: total_requests type: INTEGER description: Total number of request attempts. - name: success_count type: INTEGER description: Number of successful responses received. - name: failure_count type: INTEGER description: Number of failed responses received. - name: success_percent type: FLOAT description: Percentage of successful requests. - name: collection_name type: STRING description: Name of the collection the request belongs to. - name: collection_id type: STRING description: Identifier of the collection the request belongs to. - name: workspace_name type: STRING description: Name of the workspace containing the collection. - name: workspace_id type: STRING description: Identifier of the workspace containing the collection. rows: - - '2025-10-10T10:10:00Z' - 87654321-3346d4bb-c3f5-4f37-a80b-4e77eeb6055a - GET - Get User Profile - 1200 - 1080 - 120 - 90 - User Management API - 87654321-ff0b2687-2617-48f9-8a50-7bc5bf8ef8b0 - Partner Portal - 13f603d8-4cb2-45d1-92f8-e39891fdf387 - - '2025-10-10T10:10:00Z' - 12345678-6f719613-acee-44d2-a9b5-e9be639add94 - POST - Create Workspace - 980 - 850 - 130 - 86.7 - Workspace Admin API - 12345678-c50b4c83-f39c-4812-9a3e-5e9785011e76 - Partner Portal - 50903db2-6d98-4564-8da9-631caa258c17 - - '2025-10-10T10:10:00Z' - 56781234-4cc757c2-ffba-431d-90b2-7242cedb47f3 - PATCH - Update Member Role - 760 - 690 - 70 - 90.8 - Team Management API - 56781234-4badbb68-830b-40c8-94b7-4c195c852995 - Partner Hub - d100a067-b604-44c4-a1c1-bf414cc7b2c0 pagination: total: 42 limit: 3 offset: 0 has_more: true getAnalyticsDataPartnerWorkspaceUserRequestsSelectedUsers: value: data: summary: schema: columns: - name: user_id type: STRING description: Unique identifier of the user who sent the request. - name: request_name type: STRING description: Human-readable name of the request made by the user. - name: request_identifier_id type: STRING description: Unique identifier referencing the specific request definition. - name: collection_name type: STRING description: Name of the collection associated with the request. - name: collection_id type: STRING description: Identifier of the collection associated with the request. - name: workspace_name type: STRING description: Name of the workspace containing the request’s collection. - name: workspace_id type: STRING description: Identifier of the workspace containing the collection. - name: response_status type: INTEGER description: HTTP status code returned for the request. - name: request_ts type: TIMESTAMP format: YYYY-MM-DDTHH:MM:SSZ description: Timestamp when the request was made. rows: - - '12345678' - Get Workspace Summary - 12345678-82b01bb6-062c-4bdc-9e09-710bc8f66e75 - Workspace Insights API - 12345678-57d32d78-2d30-4fd7-9e33-4ac2213b4499 - Engineering Hub - 6755660d-38f1-4366-848b-df9f2008620d - 200 - '2025-10-10T09:55:00Z' - - '87654321' - Fetch Collection Details - 87654321-bcea09cd-cab7-4744-a971-45af229bc1ef - Collection Metrics API - 87654321-43270cfc-92d2-426e-8c1b-4f85bc8dea0a - Partner API Hub - cc7b80be-89dd-4506-912d-c27945fea4b2 - 404 - '2025-10-10T10:00:00Z' - - '56781234' - Get User Profile - 56781234-2b6d42fa-6183-4747-9a5b-d685c18487a0 - User Management API - 56781234-6a07486a-2005-4ef1-a32b-15331ae2c9b0 - Internal Tools - 19efb285-462f-4e15-94ba-3322657b5c1d - 202 - '2025-10-10T10:10:00Z' pagination: total: 25 limit: 3 offset: 0 has_more: true getAnalyticsDataPartnerWorkspaceUserRequestsSelectedRequests: value: data: summary: schema: columns: - name: user_id type: STRING description: Unique identifier of the user who sent the request. - name: request_name type: STRING description: Human-readable name of the request made by the user. - name: request_id type: STRING description: Unique identifier referencing the specific request definition. - name: collection_name type: STRING description: Name of the collection associated with the request. - name: collection_id type: STRING description: Identifier of the collection associated with the request. - name: workspace_id type: STRING description: Identifier of the workspace containing the collection. - name: response_status type: INTEGER description: HTTP status code returned for the request. - name: request_ts type: TIMESTAMP format: YYYY-MM-DDTHH:MM:SSZ description: Timestamp when the request was made. rows: - - '87654321' - New Request - 87654321-37fc31e2-f0bb-42ee-8651-b0fd0115d68a - New Collection - 87654321-91e11daa-8fe1-4e1a-a6da-6cca43251595 - c303c5b6-066f-4c58-a9ef-cb0c710ccf02 - 200 - '2025-07-30T21:55:19.000Z' - - '12345678' - Test API - 12345678-ae30eef1-e330-4666-bad2-e48bb22d8790 - Test APIs - 12345678-2f9170b4-a59f-4b44-aa93-e25cafdaa2d1 - 583a1633-d0e5-4890-be85-628c52916152 - 200 - '2026-01-13T03:57:18.000Z' - - '12345678' - Test API - 12345678-ae30eef1-e330-4666-bad2-e48bb22d8790 - Test APIs - 12345678-2f9170b4-a59f-4b44-aa93-e25cafdaa2d1 - 583a1633-d0e5-4890-be85-628c52916152 - 404 - '2026-01-13T03:57:29.000Z' pagination: total: 4 limit: 100 offset: 0 has_more: true getAnalyticsDataPartnerWorkspaceUserRequestsSelectedResponseStatus: value: data: summary: schema: columns: - name: user_id type: STRING description: Unique identifier of the user who sent the request. - name: request_name type: STRING description: Human-readable name of the request made by the user. - name: request_id type: STRING description: Unique identifier referencing the specific request definition. - name: collection_name type: STRING description: Name of the collection associated with the request. - name: collection_id type: STRING description: Identifier of the collection associated with the request. - name: workspace_id type: STRING description: Identifier of the workspace containing the collection. - name: response_status type: INTEGER description: HTTP status code returned for the request. - name: request_ts type: TIMESTAMP format: YYYY-MM-DDTHH:MM:SSZ description: Timestamp when the request was made. rows: - - '12345678' - 404 Request - 12345678-8e261547-04be-427d-b6df-db9beb7f09df - test collection - 12345678-76e46801-4e4f-4731-9203-52e6defdd7ca - 3506c6f4-c37e-4fd5-8d3f-2e69d70e9d03 - 404 - '2026-01-20T09:30:43.000Z' - - '12345678' - 404 Request - 12345678-8e261547-04be-427d-b6df-db9beb7f09df - test collection - 12345678-76e46801-4e4f-4731-9203-52e6defdd7ca - 3506c6f4-c37e-4fd5-8d3f-2e69d70e9d03 - 404 - '2026-01-20T09:32:58.000Z' - - '12345678' - Success Request - 12345678-fbacb0ad-0838-45d9-a38a-2cd1a759aae2 - test collection - 12345678-76e46801-4e4f-4731-9203-52e6defdd7ca - 3506c6f4-c37e-4fd5-8d3f-2e69d70e9d03 - 200 - '2026-01-19T11:07:44.000Z' pagination: total: 3 limit: 100 offset: 0 has_more: true getAnalyticsDataPartnerWorkspaceNeedsAttentionAttentionType: value: data: summary: schema: columns: - name: user_id type: STRING description: Unique identifier of the user. - name: request_type type: STRING description: Type of issue or request pattern detected for the user. - name: timestamp type: TIMESTAMP format: YYYY-MM-DDTHH:MM:SSZ description: Time when the request event was recorded. - name: request_name type: STRING description: Display name of the request. Present when request_type = no_success_on_tried_request. - name: request_identifier_id type: STRING description: Unique identifier for the request. Present when request_type = no_success_on_tried_request. rows: - - '12345678' - high_non_200OK_rate_for_partner - '2026-01-21T00:00:00.000Z' - partner_id - '{"partner_id":"12345678"}' - - '12345678' - high_non_200OK_rate_for_partner - '2026-01-23T00:00:00.000Z' - partner_id - '{"partner_id":"12345678"}' - - '87654321' - high_non_200OK_rate_for_partner - '2026-01-21T00:00:00.000Z' - partner_id - '{"partner_id":"87654321"}' - - '87654321' - high_non_200OK_rate_for_partner - '2026-01-23T00:00:00.000Z' - partner_id - '{"partner_id":"87654321"}' pagination: total: 4 limit: 100 offset: 0 has_more: false getAnalyticsDataPartnerWorkspacePartnerEngagementFunnelDetailed: value: data: all_partners: schema: columns: - name: user_id type: STRING description: Unique identifier of the partner user. - name: timestamp type: TIMESTAMP format: YYYY-MM-DDTHH:MM:SSZ description: Time when the partner activity was recorded. rows: - - '12345678' - '2026-01-21T00:00:00.000Z' - - '87654321' - '2026-01-21T00:00:00.000Z' - - '56781234' - '2026-01-21T00:00:00.000Z' pagination: total: 131 limit: 3 offset: 0 has_more: true workspace_visited: schema: columns: - name: user_id type: STRING description: Unique identifier of the partner user. - name: timestamp type: TIMESTAMP format: YYYY-MM-DDTHH:MM:SSZ description: Time when the partner activity was recorded. rows: - - '12345678' - '2026-01-21T00:00:00.000Z' - - '87654321' - '2026-01-21T00:00:00.000Z' - - '56781234' - '2026-01-21T00:00:00.000Z' pagination: total: 7 limit: 3 offset: 0 has_more: true viewed_collection: schema: columns: - name: user_id type: STRING description: Unique identifier of the partner user. - name: timestamp type: TIMESTAMP format: YYYY-MM-DDTHH:MM:SSZ description: Time when the partner activity was recorded. rows: - - '12345678' - '2026-01-21T00:00:00.000Z' - - '87654321' - '2026-01-21T00:00:00.000Z' - - '56781234' - '2026-01-21T00:00:00.000Z' pagination: total: 3 limit: 3 offset: 0 has_more: false request_sent: schema: columns: - name: user_id type: STRING description: Unique identifier of the partner user. - name: timestamp type: TIMESTAMP format: YYYY-MM-DDTHH:MM:SSZ description: Time when the partner activity was recorded. rows: - - '12345678' - '2026-01-21T00:00:00.000Z' - - '87654321' - '2026-01-21T00:00:00.000Z' - - '56781234' - '2026-01-21T00:00:00.000Z' pagination: total: 3 limit: 3 offset: 0 has_more: false successful_requests_200OK: schema: columns: - name: user_id type: STRING description: Unique identifier of the partner user. - name: timestamp type: TIMESTAMP format: YYYY-MM-DDTHH:MM:SSZ description: Time when the partner activity was recorded. rows: - - '12345678' - '2026-01-21T00:00:00.000Z' - - '87654321' - '2026-01-21T00:00:00.000Z' - - '56781234' - '2026-01-21T00:00:00.000Z' pagination: total: 3 limit: 3 offset: 0 has_more: false getAnalyticsDataPartnerWorkspacePartnerEngagementFunnelSummary: value: data: summary: schema: columns: - name: metric type: STRING description: Name of the partner engagement metric. - name: count type: INTEGER description: Value associated with the specific engagement metric. rows: - - all_partners - 131 - - workspace_visited - 7 - - viewed_collection - 6 - - request_sent - 3 - - successful_requests_200OK - 3 getAnalyticsDataAITopModelsDetailed: value: data: summary: rows: - - claude-sonnet-4.6 - Anthropic - 753.72 - 265 - - gpt-5.4 - OpenAI - 206.231 - 67 - - claude-opus-4.6 - Anthropic - 158.068 - 46 - - gpt-5.5 - OpenAI - 125.358 - 10 - - claude-haiku-4.5 - Anthropic - 108.582 - 51 - - claude-sonnet-4.5 - Anthropic - 56.641 - 11 - - claude-opus-4.7 - Anthropic - 25.361 - 14 - - moonshotai.kimi-k2.5 - Moonshotai - 5.232 - 3 - - claude-opus-4.5 - Anthropic - 3.431 - 5 - - deepseek-chat-v3.0324 - DeepSeek - 2.638 - 4 pagination: offset: 0 total: 11 has_more: true limit: 10 schema: columns: - type: STRING description: AI model name. name: model - type: STRING description: AI model provider. name: provider - type: FLOAT description: AI credits used. name: ai_credits_used - type: INTEGER description: Number of distinct messages. name: message_count getAnalyticsDataAIActivityDistribution: value: data: summary: schema: columns: - name: timestamp description: Bucket start timestamp. type: TIMESTAMP - name: total_credits description: Total credits consumed in the bucket. type: FLOAT - name: total_users description: Total users active in the bucket. type: INTEGER - name: usage_level description: Usage classification for the bucket. type: STRING rows: - - '2026-04-26 05:00:00' - 1.398 - 1 - Low Usage - - '2026-04-27 03:00:00' - 1.339 - 1 - Low Usage - - '2026-04-27 05:00:00' - 58.509 - 1 - Moderate Usage - - '2026-04-27 06:00:00' - 3.047 - 2 - Low Usage - - '2026-04-27 07:00:00' - 313.551 - 3 - High Usage - - '2026-04-27 08:00:00' - 23.97 - 3 - Low Usage - - '2026-04-27 09:00:00' - 148.522 - 6 - Low Usage - - '2026-04-27 10:00:00' - 60.232 - 4 - Low Usage - - '2026-04-27 11:00:00' - 41.297 - 4 - Low Usage - - '2026-04-27 12:00:00' - 22.733 - 1 - Low Usage - - '2026-04-27 15:00:00' - 0.699 - 1 - Low Usage - - '2026-04-27 16:00:00' - 0.835 - 1 - Low Usage - - '2026-04-27 17:00:00' - 925.75 - 3 - High Usage - - '2026-04-27 18:00:00' - 67.065 - 2 - Low Usage - - '2026-04-27 19:00:00' - 13.501 - 3 - Low Usage - - '2026-04-27 20:00:00' - 46.812 - 2 - Low Usage - - '2026-04-27 21:00:00' - 6.852 - 1 - Low Usage - - '2026-04-28 03:00:00' - 318.591 - 1 - High Usage - - '2026-04-28 05:00:00' - 0.302 - 1 - Low Usage - - '2026-04-28 06:00:00' - 147.383 - 4 - Low Usage - - '2026-04-28 07:00:00' - 472.18 - 3 - High Usage - - '2026-04-28 08:00:00' - 34.198 - 2 - Low Usage - - '2026-04-28 09:00:00' - 13.104 - 4 - Low Usage - - '2026-04-28 10:00:00' - 33.33 - 7 - Low Usage - - '2026-04-28 11:00:00' - 39.761 - 3 - Low Usage - - '2026-04-28 12:00:00' - 26.326 - 3 - Low Usage - - '2026-04-28 13:00:00' - 16.37 - 1 - Low Usage - - '2026-04-28 15:00:00' - 4.308 - 1 - Low Usage - - '2026-04-28 16:00:00' - 58.582 - 2 - Low Usage - - '2026-04-28 17:00:00' - 8.746 - 3 - Low Usage - - '2026-04-28 18:00:00' - 13.899 - 1 - Low Usage - - '2026-04-28 19:00:00' - 0.27 - 1 - Low Usage - - '2026-04-28 20:00:00' - 0.872 - 1 - Low Usage - - '2026-04-28 21:00:00' - 1.08 - 1 - Low Usage - - '2026-04-28 22:00:00' - 0.883 - 1 - Low Usage - - '2026-04-28 23:00:00' - 1.368 - 1 - Low Usage - - '2026-04-29 00:00:00' - 1.48 - 1 - Low Usage - - '2026-04-29 01:00:00' - 3.065 - 1 - Low Usage - - '2026-04-29 02:00:00' - 5.328 - 2 - Low Usage - - '2026-04-29 03:00:00' - 4.167 - 3 - Low Usage - - '2026-04-29 04:00:00' - 27.279 - 3 - Low Usage - - '2026-04-29 05:00:00' - 2.07 - 2 - Low Usage - - '2026-04-29 06:00:00' - 19.894 - 3 - Low Usage - - '2026-04-29 07:00:00' - 160.454 - 4 - Moderate Usage - - '2026-04-29 08:00:00' - 46.599 - 4 - Low Usage - - '2026-04-29 09:00:00' - 28.277 - 8 - Low Usage - - '2026-04-29 10:00:00' - 15.97 - 3 - Low Usage - - '2026-04-29 11:00:00' - 75.737 - 2 - Low Usage - - '2026-04-29 12:00:00' - 2.885 - 2 - Low Usage - - '2026-04-29 13:00:00' - 17.399 - 1 - Low Usage - - '2026-04-29 16:00:00' - 1.775 - 1 - Low Usage - - '2026-04-29 18:00:00' - 61.568 - 3 - Low Usage - - '2026-04-29 19:00:00' - 18.85 - 1 - Low Usage - - '2026-04-29 20:00:00' - 67.431 - 1 - Moderate Usage - - '2026-04-29 21:00:00' - 1.357 - 1 - Low Usage - - '2026-04-30 02:00:00' - 19.683 - 1 - Low Usage - - '2026-04-30 03:00:00' - 12.191 - 1 - Low Usage - - '2026-04-30 04:00:00' - 1.057 - 1 - Low Usage - - '2026-04-30 06:00:00' - 13.711 - 2 - Low Usage - - '2026-04-30 07:00:00' - 1.358 - 1 - Low Usage - - '2026-04-30 08:00:00' - 0.91 - 1 - Low Usage - - '2026-04-30 10:00:00' - 8.425 - 1 - Low Usage - - '2026-04-30 11:00:00' - 44.282 - 2 - Low Usage - - '2026-04-30 12:00:00' - 7.489 - 2 - Low Usage - - '2026-04-30 13:00:00' - 2.842 - 1 - Low Usage - - '2026-04-30 14:00:00' - 12.007 - 1 - Low Usage - - '2026-04-30 15:00:00' - 76.631 - 3 - Low Usage - - '2026-04-30 16:00:00' - 38.362 - 2 - Low Usage - - '2026-04-30 20:00:00' - 12.58 - 2 - Low Usage - - '2026-04-30 21:00:00' - 6.732 - 1 - Low Usage - - '2026-04-30 22:00:00' - 0.27 - 1 - Low Usage - - '2026-04-30 23:00:00' - 0.693 - 1 - Low Usage - - '2026-05-01 01:00:00' - 22.895 - 1 - Low Usage - - '2026-05-01 02:00:00' - 0.685 - 1 - Low Usage - - '2026-05-01 15:00:00' - 0.54 - 1 - Low Usage - - '2026-05-01 16:00:00' - 90.991 - 1 - High Usage - - '2026-05-01 18:00:00' - 3.228 - 1 - Low Usage - - '2026-05-01 22:00:00' - 0.635 - 1 - Low Usage - - '2026-05-02 02:00:00' - 0.362 - 1 - Low Usage getAnalyticsDataAIPeakActivity: value: data: summary: rows: - - Tue (May 12) - '2026-05-12 00:00:00' - '2026-05-13 00:00:00' - 296.107 schema: columns: - type: STRING description: Display-friendly label describing the peak window. Format depends on the requested duration filter. name: most_active_window - type: TIMESTAMP description: Start of the peak activity window. name: bucket_start - type: TIMESTAMP description: End of the peak activity window (exclusive). name: bucket_end - type: FLOAT description: Total credits consumed in the peak period. name: credits_used getAnalyticsDataAIRankedUsageLeaderboardFilterUser: value: data: summary: rows: - - '12345678' - Taylor Lee - taylor.lee@example.com - 1 - 70 - 226 - 7597.144 schema: columns: - type: STRING description: Unique identifier for the user. name: user_id - type: STRING description: Display name of the user. name: user_name - type: STRING description: Email address of the user. name: user_email - type: INTEGER description: Leaderboard rank. name: rank - type: INTEGER description: Number of agent mode sessions. name: agent_mode_sessions - type: INTEGER description: Number of messages sent. name: messages_sent - type: FLOAT description: Total AI credits consumed. name: ai_credits_used getAnalyticsDataAIRankedUsageLeaderboard: value: data: summary: schema: columns: - type: STRING name: user_id description: Unique identifier for the user. - type: STRING name: user_name description: Display name of the user. - type: STRING name: user_email description: Email address of the user. - type: INTEGER name: rank description: Leaderboard rank. - type: INTEGER name: agent_mode_sessions description: Number of agent mode sessions. - type: INTEGER name: messages_sent description: Number of messages sent. - type: FLOAT name: ai_credits_used description: Total AI credits consumed. rows: - - '12345678' - Taylor Lee - taylor.lee@example.com - 1 - 70 - 226 - 7597.144 - - '56781234' - Alex Cruz - alex.cruz@example.com - 2 - 41 - 117 - 1949.872 - - '43218765' - Kim Allen - kim.allen@example.com - 3 - 50 - 73 - 1881.436 getAnalyticsDataAIModelCreditUsageByModelTrend: value: data: summary: rows: - - '2026-04-01' - claude-3.7-sonnet - 588.156 - 156 - - '2026-04-01' - claude-opus-4.6 - 156.589 - 17 - - '2026-04-01' - claude-sonnet-4.5 - 188.21 - 19 - - '2026-04-01' - claude-sonnet-4.6 - 2226.067 - 92 - - '2026-04-01' - deepseek-chat-v3.0324 - 0.551 - 1 - - '2026-04-01' - deepseek-r1 - 1.324 - 1 - - '2026-04-01' - gemini-3.1-pro-preview - 2.913 - 4 - - '2026-04-01' - gpt-4.1 - 31.608 - 43 - - '2026-04-01' - gpt-5 - 30.598 - 34 - - '2026-04-01' - gpt-5.2 - 0.5 - 1 - - '2026-04-01' - gpt-5.3-codex - 6.362 - 6 - - '2026-04-01' - gpt-5.4 - 303.824 - 65 - - '2026-04-01' - llama-4-maverick - 1.196 - 2 - - '2026-04-01' - llama-4-scout - 0.597 - 1 - - '2026-04-02' - claude-3.7-sonnet - 33.084 - 12 - - '2026-04-02' - claude-haiku-4.5 - 38.917 - 15 - - '2026-04-02' - claude-opus-4.5 - 8.239 - 4 - - '2026-04-02' - claude-opus-4.6 - 526.387 - 73 - - '2026-04-02' - claude-sonnet-4 - 55.897 - 9 - - '2026-04-02' - claude-sonnet-4.5 - 0.522 - 1 - - '2026-04-02' - claude-sonnet-4.6 - 785.882 - 104 - - '2026-04-02' - deepseek-r1 - 1.97 - 3 - - '2026-04-02' - gemini-3-flash-preview - 1.038 - 2 - - '2026-04-02' - gemini-3.1-pro-preview - 0.401 - 1 - - '2026-04-02' - gpt-4.1 - 19.404 - 31 - - '2026-04-02' - gpt-5 - 18.375 - 17 - - '2026-04-02' - gpt-5.4 - 93.286 - 26 - - '2026-04-02' - moonshotai.kimi-k2.5 - 6.027 - 8 - - '2026-04-03' - claude-opus-4.6 - 52.262 - 23 - - '2026-04-03' - gpt-4.1 - 0.375 - 1 - - '2026-04-05' - gpt-4.1 - 0.388 - 2 - - '2026-04-05' - gpt-5 - 0.205 - 1 - - '2026-04-06' - claude-opus-4.6 - 2286.821 - 97 - - '2026-04-06' - claude-sonnet-4.6 - 877.569 - 105 - - '2026-04-06' - gpt-4.1 - 74.659 - 49 - - '2026-04-06' - gpt-5 - 97.274 - 47 - - '2026-04-06' - gpt-5.3-codex - 0.955 - 2 - - '2026-04-06' - moonshotai.kimi-k2.5 - 202.63 - 98 - - '2026-04-07' - claude-haiku-4.5 - 9.201 - 1 - - '2026-04-07' - claude-opus-4.6 - 247.089 - 18 - - '2026-04-07' - claude-sonnet-4.6 - 306.646 - 38 - - '2026-04-07' - gpt-4.1 - 16.899 - 22 - - '2026-04-07' - gpt-5 - 23.35 - 23 - - '2026-04-07' - gpt-5.4 - 21.699 - 13 - - '2026-04-07' - moonshotai.kimi-k2.5 - 7.89 - 3 - - '2026-04-08' - claude-haiku-4.5 - 20.168 - 9 - - '2026-04-08' - claude-opus-4.5 - 8.933 - 1 - - '2026-04-08' - claude-opus-4.6 - 425.127 - 21 - - '2026-04-08' - claude-sonnet-4.6 - 5.451 - 1 - - '2026-04-08' - deepseek-r1 - 1.423 - 1 - - '2026-04-08' - gpt-4.1 - 53.944 - 50 - - '2026-04-08' - gpt-5 - 82.26 - 44 - - '2026-04-08' - gpt-5.2 - 6.223 - 1 - - '2026-04-08' - gpt-5.4 - 17.699 - 9 - - '2026-04-08' - moonshotai.kimi-k2.5 - 0.651 - 1 - - '2026-04-09' - claude-haiku-4.5 - 21.707 - 11 - - '2026-04-09' - claude-opus-4.5 - 2.138 - 1 - - '2026-04-09' - claude-opus-4.6 - 480.012 - 28 - - '2026-04-09' - claude-sonnet-4.6 - 41.86 - 8 - - '2026-04-09' - gpt-4.1 - 64.967 - 30 - - '2026-04-09' - gpt-5 - 69.022 - 36 - - '2026-04-09' - gpt-5.2 - 11.96 - 2 - - '2026-04-09' - gpt-5.4 - 22.189 - 9 - - '2026-04-09' - moonshotai.kimi-k2.5 - 3.743 - 4 - - '2026-04-10' - claude-opus-4.6 - 30.134 - 7 - - '2026-04-10' - claude-sonnet-4.6 - 179.096 - 7 - - '2026-04-10' - gpt-4.1 - 10.72 - 13 - - '2026-04-10' - gpt-5 - 4.874 - 8 - - '2026-04-10' - gpt-5.2 - 36.792 - 8 - - '2026-04-10' - gpt-5.4 - 0.501 - 1 - - '2026-04-13' - claude-haiku-4.5 - 4.298 - 5 - - '2026-04-13' - claude-opus-4.6 - 23.538 - 5 - - '2026-04-13' - claude-sonnet-4.6 - 106.863 - 17 - - '2026-04-13' - gpt-4.1 - 53.926 - 54 - - '2026-04-13' - gpt-5 - 71.772 - 45 - - '2026-04-13' - gpt-5.2 - 3.596 - 4 - - '2026-04-13' - gpt-5.4 - 0.569 - 1 - - '2026-04-14' - claude-haiku-4.5 - 132.068 - 45 - - '2026-04-14' - claude-opus-4.5 - 223.275 - 72 - - '2026-04-14' - claude-opus-4.6 - 328.479 - 66 - - '2026-04-14' - claude-sonnet-4.5 - 74.737 - 24 - - '2026-04-14' - claude-sonnet-4.6 - 173.166 - 51 - - '2026-04-14' - gemini-3.1-pro-preview - 11.691 - 25 - - '2026-04-14' - gpt-4.1 - 40.794 - 41 - - '2026-04-14' - gpt-5 - 50.524 - 30 - - '2026-04-14' - gpt-5.2 - 251.219 - 79 - - '2026-04-14' - gpt-5.3-codex - 19.071 - 39 - - '2026-04-14' - gpt-5.4 - 99.139 - 49 - - '2026-04-14' - moonshotai.kimi-k2.5 - 121.888 - 48 - - '2026-04-15' - claude-3.5-haiku - 2.547 - 1 - - '2026-04-15' - claude-haiku-4.5 - 115.676 - 40 - - '2026-04-15' - claude-opus-4.5 - 9.508 - 1 - - '2026-04-15' - claude-opus-4.6 - 204.807 - 44 - - '2026-04-15' - claude-sonnet-4.5 - 46.104 - 6 - - '2026-04-15' - claude-sonnet-4.6 - 134.635 - 49 - - '2026-04-15' - gpt-4.1 - 82.783 - 39 - - '2026-04-15' - gpt-5 - 77.188 - 40 - - '2026-04-15' - gpt-5.2 - 91.789 - 17 - - '2026-04-15' - gpt-5.4 - 66.957 - 45 - - '2026-04-15' - moonshotai.kimi-k2.5 - 12.027 - 7 - - '2026-04-16' - claude-opus-4.6 - 256.961 - 37 - - '2026-04-16' - claude-sonnet-4.5 - 29.072 - 11 - - '2026-04-16' - claude-sonnet-4.6 - 205.515 - 21 - - '2026-04-16' - gpt-4.1 - 114.482 - 78 - - '2026-04-16' - gpt-5 - 142.534 - 69 - - '2026-04-16' - gpt-5.2 - 86.089 - 16 - - '2026-04-16' - gpt-5.4 - 3.29 - 1 - - '2026-04-16' - moonshotai.kimi-k2.5 - 1.719 - 2 - - '2026-04-17' - claude-haiku-4.5 - 2.431 - 3 - - '2026-04-17' - claude-opus-4.6 - 119.087 - 16 - - '2026-04-17' - claude-sonnet-4.5 - 4.959 - 2 - - '2026-04-17' - claude-sonnet-4.6 - 984.411 - 101 - - '2026-04-17' - gpt-4.1 - 77.319 - 46 - - '2026-04-17' - gpt-5 - 91.512 - 50 - - '2026-04-17' - gpt-5.2 - 0.605 - 1 - - '2026-04-17' - gpt-5.4 - 3.874 - 2 - - '2026-04-18' - claude-opus-4.6 - 243.951 - 45 - - '2026-04-19' - claude-opus-4.6 - 9.307 - 4 - - '2026-04-19' - gpt-4.1 - 0.685 - 2 - - '2026-04-19' - gpt-5 - 1.525 - 4 - - '2026-04-19' - gpt-5.4 - 4.108 - 1 - - '2026-04-20' - claude-opus-4.6 - 1528.047 - 82 - - '2026-04-20' - claude-sonnet-4.5 - 4.709 - 4 - - '2026-04-20' - claude-sonnet-4.6 - 779.813 - 9 - - '2026-04-20' - gpt-4.1 - 35.513 - 42 - - '2026-04-20' - gpt-5 - 35.678 - 38 - - '2026-04-20' - gpt-5.2 - 0.623 - 1 - - '2026-04-20' - gpt-5.4 - 66.727 - 17 - - '2026-04-21' - claude-3.5-haiku - 21.347 - 8 - - '2026-04-21' - claude-haiku-4.5 - 163.323 - 49 - - '2026-04-21' - claude-opus-4.5 - 180.281 - 48 - - '2026-04-21' - claude-opus-4.6 - 417.854 - 57 - - '2026-04-21' - claude-opus-4.7 - 253.986 - 54 - - '2026-04-21' - claude-sonnet-4 - 96.813 - 30 - - '2026-04-21' - claude-sonnet-4.5 - 171.291 - 56 - - '2026-04-21' - claude-sonnet-4.6 - 433.23 - 88 - - '2026-04-21' - gpt-4.1 - 47.454 - 35 - - '2026-04-21' - gpt-5 - 58.548 - 31 - - '2026-04-21' - gpt-5.2 - 13.155 - 7 - - '2026-04-21' - gpt-5.4 - 18.852 - 8 - - '2026-04-22' - claude-3.5-haiku - 130.951 - 40 - - '2026-04-22' - claude-haiku-4.5 - 0.855 - 1 - - '2026-04-22' - claude-opus-4.6 - 55.081 - 17 - - '2026-04-22' - claude-opus-4.7 - 400.241 - 71 - - '2026-04-22' - claude-sonnet-4 - 120.595 - 18 - - '2026-04-22' - claude-sonnet-4.6 - 78.811 - 40 - - '2026-04-22' - deepseek-chat-v3.0324 - 3.436 - 2 - - '2026-04-22' - gpt-4.1 - 76.501 - 43 - - '2026-04-22' - gpt-5 - 95.02 - 39 - - '2026-04-22' - gpt-5.2 - 81.543 - 41 - - '2026-04-22' - gpt-5.4 - 101.625 - 40 - - '2026-04-22' - moonshotai.kimi-k2.5 - 1.801 - 1 - - '2026-04-23' - claude-opus-4.5 - 4.897 - 1 - - '2026-04-23' - claude-opus-4.6 - 396.819 - 28 - - '2026-04-23' - claude-opus-4.7 - 29.402 - 5 - - '2026-04-23' - claude-sonnet-4.6 - 17.755 - 15 - - '2026-04-23' - gpt-4.1 - 30.032 - 24 - - '2026-04-23' - gpt-5 - 41.294 - 19 - - '2026-04-23' - gpt-5.4 - 7.803 - 3 - - '2026-04-24' - claude-opus-4.6 - 163.618 - 7 - - '2026-04-24' - claude-opus-4.7 - 61.245 - 46 - - '2026-04-24' - claude-sonnet-4.5 - 98.622 - 38 - - '2026-04-24' - claude-sonnet-4.6 - 17.564 - 18 - - '2026-04-24' - deepseek-r1 - 0.811 - 1 - - '2026-04-24' - gpt-4.1 - 36.651 - 23 - - '2026-04-24' - gpt-5 - 43.459 - 24 - - '2026-04-24' - gpt-5.4 - 1.287 - 2 - - '2026-04-25' - claude-opus-4.7 - 55.359 - 9 - - '2026-04-25' - gpt-5 - 0.769 - 2 - - '2026-04-26' - gpt-4.1 - 1.398 - 2 - - '2026-04-27' - claude-haiku-4.5 - 107.275 - 29 - - '2026-04-27' - claude-opus-4.6 - 0.935 - 1 - - '2026-04-27' - claude-opus-4.7 - 1271.763 - 23 - - '2026-04-27' - claude-sonnet-4.5 - 7.337 - 3 - - '2026-04-27' - claude-sonnet-4.6 - 188.273 - 44 - - '2026-04-27' - gpt-4.1 - 72.707 - 55 - - '2026-04-27' - gpt-5 - 82.27 - 45 - - '2026-04-27' - gpt-5.2 - 0.835 - 1 - - '2026-04-27' - gpt-5.4 - 3.319 - 2 - - '2026-04-28' - claude-haiku-4.5 - 57.449 - 15 - - '2026-04-28' - claude-opus-4.6 - 15.961 - 9 - - '2026-04-28' - claude-opus-4.7 - 929.728 - 31 - - '2026-04-28' - claude-sonnet-4.6 - 117.642 - 56 - - '2026-04-28' - gpt-4.1 - 27.737 - 39 - - '2026-04-28' - gpt-5 - 23.636 - 25 - - '2026-04-28' - gpt-5.2 - 1.201 - 2 - - '2026-04-28' - gpt-5.4 - 17.366 - 8 - - '2026-04-28' - moonshotai.kimi-k2.5 - 0.833 - 1 - - '2026-04-29' - claude-haiku-4.5 - 4.674 - 1 - - '2026-04-29' - claude-opus-4.6 - 61.7 - 16 - - '2026-04-29' - claude-sonnet-4.6 - 318.873 - 62 - - '2026-04-29' - gpt-4.1 - 83.266 - 71 - - '2026-04-29' - gpt-5 - 93.072 - 57 schema: columns: - name: created_at type: DATE description: Date of credit usage. - name: model type: STRING description: AI model name. - name: ai_credits_used type: FLOAT description: AI credits used. - name: message_count type: INTEGER description: Number of distinct messages. getAnalyticsDataAICreditUsageSummary: value: data: summary: rows: - - 18926.453 - 1025600 schema: columns: - type: FLOAT description: Current credit usage (in millicredits). name: usage - type: FLOAT description: Credit limit for the team (in millicredits). name: limit getAnalyticsDataAIMessagesSentTrend: value: data: summary: schema: columns: - type: DATE description: Date of the messages. name: created_date - type: INTEGER description: Distinct messages sent on this date. name: messages_sent rows: - - '2026-04-06' - 248 - - '2026-04-07' - 312 - - '2026-04-08' - 289 - - '2026-04-09' - 275 - - '2026-04-10' - 198 - - '2026-04-13' - 341 - - '2026-04-14' - 305 - - '2026-04-15' - 267 - - '2026-04-16' - 389 - - '2026-04-17' - 215 getAnalyticsDataAIMessagesSentSummary: value: data: summary: schema: columns: - name: messages_sent description: Distinct messages sent. type: INTEGER - name: change description: Percentage change from the previous period. type: FLOAT - name: change_type description: Indicates whether the change is an increase, decrease, no_change, or new_data. type: STRING rows: - - 4792 - 127.97335870599 - increase getAnalyticsDataAIAgentModeSessionsTrend: value: data: summary: schema: columns: - type: DATE description: Date of the sessions. name: created_date - type: INTEGER description: Distinct agent mode sessions on this date. name: agent_mode_sessions rows: - - '2026-04-06' - 156 - - '2026-04-07' - 189 - - '2026-04-08' - 172 - - '2026-04-09' - 164 - - '2026-04-10' - 118 - - '2026-04-13' - 201 - - '2026-04-14' - 195 - - '2026-04-15' - 148 - - '2026-04-16' - 225 - - '2026-04-17' - 134 getAnalyticsDataAIAgentModeSessionsSummary: value: data: summary: rows: - - 300 - -66.024915062288 - decrease schema: columns: - name: agent_mode_sessions type: INTEGER description: Distinct agent mode sessions. - name: change type: FLOAT description: Percentage change from the previous period. - name: change_type type: STRING description: Indicates whether the change is an increase, decrease, no_change, or new_data. getAnalyticsDataAINewVsReturningUsersDetailed: value: data: summary: schema: columns: - name: period_start description: Start of the aggregation period. type: DATE - name: user_type description: Whether the user is new or returning. type: STRING - name: user_id description: Unique identifier for the user. type: STRING - name: user_name description: Display name of the user. type: STRING - name: user_email description: Email address of the user. type: STRING - name: agent_mode_sessions description: Number of agent mode sessions. type: INTEGER - name: messages_sent description: Number of messages sent. type: INTEGER - name: ai_credits_used description: Total AI credits consumed. type: FLOAT rows: - - '2026-04-06' - returning - '12345678' - Taylor Lee - taylor.lee@example.com - 24 - 75 - 2290.794 - - '2026-04-27' - returning - '56781234' - Alex Cruz - alex.cruz@example.com - 4 - 13 - 1124.856 - - '2026-04-20' - returning - '43218765' - Kim Allen - kim.allen@example.com - 7 - 18 - 1102.369 getAnalyticsDataAINewVsReturningSummary: value: data: summary: schema: columns: - name: user_type type: STRING description: Whether the user is new or returning. - name: total_users type: INTEGER description: Distinct users in the segment over the duration. - name: agent_mode_sessions type: INTEGER description: Total agent mode sessions for the segment. - name: messages_sent type: INTEGER description: Total messages sent for the segment. - name: ai_credits_used type: FLOAT description: Total AI credits consumed by the segment. rows: - - new - 7 - 516 - 545 - 2025.834 - - returning - 57 - 988 - 1698 - 10289.229000000005 getAnalyticsDataAINewVsReturningTrend: value: data: summary: schema: columns: - name: period_start description: Start of the aggregation period. type: DATE - name: new_users description: Count of new users in the period. type: INTEGER - name: returning_users description: Count of returning users in the period. type: INTEGER - name: total_users description: Total distinct users in the period. type: INTEGER rows: - - '2026-04-03' - 0 - 2 - 2 - - '2026-04-05' - 1 - 1 - 2 - - '2026-04-06' - 0 - 13 - 13 - - '2026-04-07' - 1 - 16 - 17 - - '2026-04-08' - 2 - 16 - 18 - - '2026-04-09' - 0 - 19 - 19 - - '2026-04-10' - 0 - 12 - 12 - - '2026-04-13' - 0 - 18 - 18 - - '2026-04-14' - 1 - 18 - 19 - - '2026-04-15' - 1 - 16 - 17 - - '2026-04-16' - 1 - 24 - 25 - - '2026-04-17' - 0 - 15 - 15 - - '2026-04-18' - 0 - 1 - 1 - - '2026-04-19' - 0 - 3 - 3 - - '2026-04-20' - 1 - 20 - 21 - - '2026-04-21' - 1 - 19 - 20 - - '2026-04-22' - 2 - 15 - 17 - - '2026-04-23' - 0 - 18 - 18 - - '2026-04-24' - 0 - 11 - 11 - - '2026-04-25' - 0 - 2 - 2 - - '2026-04-26' - 0 - 1 - 1 - - '2026-04-27' - 1 - 13 - 14 - - '2026-04-28' - 0 - 11 - 11 getAnalyticsDataAIAgentModeUsersTrend: value: data: summary: schema: columns: - description: Distinct users who used agent mode. name: agent_mode_users type: INTEGER - description: Percentage change from the previous period. name: change type: FLOAT - description: Indicates whether the change is an increase, decrease, no_change, or new_data. name: change_type type: STRING rows: - - 41 - -8.8888888888889 - decrease getAnalyticsDataAIAgentModeUsersSummary: value: data: summary: schema: columns: - description: Distinct users who used agent mode. name: agent_mode_users type: INTEGER - description: Percentage change from the previous period. name: change type: FLOAT - description: Indicates whether the change is an increase, decrease, no_change, or new_data. name: change_type type: STRING rows: - - 41 - -8.8888888888889 - decrease getAnalyticsDataAPIManagementPopularWorkspacesDetailed: value: data: summary: pagination: limit: 5 offset: 0 has_more: true total: 102 schema: columns: - description: Workspace entity identifier. type: STRING name: entity_id - description: Resolved workspace display name. type: STRING name: entity_name - description: Sum of workspace active actions for this workspace. type: INTEGER name: action_value rows: - - 3e0ff5e0-f10c-4536-89b2-ae14375c166f - null - 1632 - - 6040522a-4b9a-45b1-b65c-21c06a49ddf3 - null - 1632 - - 533ebc3f-58a4-40eb-a743-32a9025f9719 - null - 1632 - - 15809062-19f9-4b6e-9d98-4260a24928b7 - null - 1632 - - cfea8b39-dee1-43a8-a6f9-133eee99a184 - null - 408 getAnalyticsDataAPIManagementWorkspaceActivityTrend: value: data: summary: rows: - - '2026-05-06' - 2 - - '2026-05-07' - 3 - - '2026-05-08' - 2 - - '2026-05-09' - 2 - - '2026-05-12' - 1 - - '2026-05-13' - 1 - - '2026-05-16' - 2 - - '2026-05-17' - 1 - - '2026-05-18' - 1 - - '2026-05-20' - 2 - - '2026-05-21' - 3 - - '2026-05-23' - 1 - - '2026-05-26' - 1 schema: columns: - name: timestamp_date type: DATE description: Date bucket. - name: entity_count type: INTEGER description: Distinct workspace count on this date. getAnalyticsDataAPIManagementWorkspaceActivitySummary: value: data: summary: schema: columns: - name: entity_count description: Distinct active workspace count for API management. type: INTEGER - name: change_percentage description: Percentage change vs previous period. type: FLOAT - name: change_type description: increase | decrease | no_change | new_data type: STRING rows: - - 22 - -21.428571428571 - decrease getAnalyticsDataAPIDistributionPublicDetailed: value: data: summary: schema: columns: - description: Workspace entity identifier. name: entity_id type: STRING - description: Resolved workspace display name. name: entity_name type: STRING - description: Sum of view actions for this workspace. name: action_value type: INTEGER pagination: limit: 5 offset: 0 total: 96 has_more: true rows: - - b31f38d4-4ba8-4233-b4b5-fbddb9953459 - API Test - 3278 - - 19dc35bf-b693-4fe9-a744-96ac99491d7d - Testing - 3278 - - d12f7f46-fee0-4aee-bfa8-52055a511b86 - Testing 2 - 3278 - - 06e81de5-d31e-4ea6-8ab7-3934c3692b2f - TESTING WORKSPACE - 3278 - - 75e3a36f-b3a8-4315-a371-499439d5fd72 - Governance RBAC - 3278 getAnalyticsDataAPIDistributionPublicSummary: value: data: summary: rows: - - 24 - -4 - decrease schema: columns: - description: Distinct workspace count in Public API Network. type: INTEGER name: entity_count - description: Percentage change vs previous period. type: FLOAT name: change_percentage - description: increase | decrease | no_change | new_data type: STRING name: change_type getAnalyticsDataAPIDistributionPartnerDetailed: value: data: summary: schema: columns: - description: Workspace entity identifier. name: entity_id type: STRING - description: Resolved workspace display name. name: entity_name type: STRING - description: Sum of view actions for this workspace. name: action_value type: INTEGER rows: - - 6e40d823-f4e7-42ef-8198-418b7478b68e - API Testing - 2828 - - 758665b9-a206-4c64-b108-698e26bc9de2 - API Bug Testing - 2828 - - 52fb3f71-5ff6-42bd-a5a3-fb3809324666 - Testing Demo - 2828 - - 3acdb8b3-46df-4446-bcf5-64849cb25172 - '[BETA] Performance' - 2828 - - 659e5716-e35e-4c9b-8462-dda58c5166c7 - '[BETA] Workspace' - 2828 pagination: has_more: true offset: 0 total: 100 limit: 5 getAnalyticsDataAPIDistributionPartnerSummary: value: data: summary: rows: - - 25 - -3.8461538461538 - decrease schema: columns: - name: entity_count type: INTEGER description: Distinct workspace count in Partner Network. - name: change_percentage type: FLOAT description: Percentage change vs previous period. - name: change_type type: STRING description: increase | decrease | no_change | new_data getAnalyticsDataAPIDistributionPrivateNetworkDetailed: value: data: summary: schema: columns: - description: Workspace entity identifier. name: entity_id type: STRING - description: Resolved workspace display name. name: entity_name type: STRING - description: Sum of view actions for this workspace. name: action_value type: INTEGER rows: - - 609ad43c-7add-4328-a53d-49022e13690a - Feature Usage Testing - 2558 - - 81416a94-6323-45b9-a236-40a25c626b84 - '[gitV2]GLC' - 2558 - - 56db54b0-dc2d-4101-9cd3-0c0c791e226e - '[Jia] v12 Testing' - 2558 - - 27aed3e8-65a3-4ac7-94df-acde41fafe1a - '[cbrehm] testing 2' - 2558 - - d6f15d19-1fbb-4706-a576-9ffd6d5a371a - '[2MAY] SHREYANSH TESTING WORKSPACE' - 2558 - - 980fbe8b-8a1a-4fee-b697-ba05d8d959e6 - '[Public] Governance RBAC' - 2558 - - 6f6bcbf1-8673-42df-bccf-dd03c81c1a64 - '[Beta] Watch Service' - 2558 - - e31d000d-b21e-4b3a-85cf-9a924a1e5765 - '[BETA] Public workspace OGGGG' - 2558 - - 480a9003-84a7-46f1-8925-ddaad65418e1 - '[DANGER] Do not join sup hahahha' - 2558 - - b343ee30-7926-4afa-950c-bc5b098eee49 - '!!!!!! A Public Workspace' - 2558 - - 01f0bfee-7368-40c4-9699-b1fd273a9b31 - Live Debugging - 2558 - - 165dea5f-1c89-411b-a8e1-78265d91b6c4 - '[Adwait] public ws creation testing' - 2558 - - 4540d410-ef72-4977-afb8-d7f53705f379 - ' Composable Flows' - 2558 - - 61ac1b37-a9ed-4638-9362-cd65a79ec792 - '[Private workspace]' - 2558 - - d675f1df-b006-4c4b-b011-086f8773f7e7 - '[Adwait] Testing Org role on public ws creation' - 2558 - - 2cd62de7-beb7-4300-95d0-81dff4d5f421 - '[Jia] v12' - 2558 - - 40ed1dc9-dc30-4cb8-960a-c94598053e81 - '[Destroy] New Public Workspace' - 2558 - - 33727e8a-5b5b-4958-83f5-d61b792a48e0 - '[DO NOT JOIN] Workspace with a lot of history' - 2558 - - 280000f6-25e8-4963-9f85-1a97ffcb53cb - '[cbrehm] testing' - 2558 - - f063ce0f-a648-49d4-9d8a-e3f878529afa - '[Shub''s] Workpsace to test History' - 2558 - - 301bf21f-a374-4c10-8050-5702f1b50ff6 - '[APISEC-158] | RG | tmp workspace' - 2558 - - 764d1ae2-820d-448e-83de-a9d749222c46 - '[gitV1]GLC Demo' - 2558 - - b8d176eb-c850-4cae-864d-c356cfdea436 - '[BETA] SpecHub Performance' - 2558 - - 917ab30c-2918-4a91-bc9e-ead7cf9c483c - '[Jia] v12 testing but public' - 2558 pagination: has_more: false offset: 0 total: 96 limit: 100 getAnalyticsDataAPIDistributionPrivateNetworkSummary: value: data: summary: rows: - - 24 - -7.6923076923077 - decrease schema: columns: - name: entity_count type: INTEGER description: Distinct workspace count in Private API Network. - name: change_percentage type: FLOAT description: Percentage change vs previous period. - name: change_type type: STRING description: increase | decrease | no_change | new_data getAnalyticsDataAPIDistributionActiveWorkspacesTrend: value: data: summary: rows: - - partner - '2026-05-06' - 8484 - - partner - '2026-05-07' - 8484 - - partner - '2026-05-08' - 8484 - - partner - '2026-05-09' - 16968 - - partner - '2026-05-10' - 25452 - - partner - '2026-05-12' - 8484 - - partner - '2026-05-15' - 8484 - - partner - '2026-05-16' - 16968 - - partner - '2026-05-17' - 8484 - - partner - '2026-05-18' - 16968 - - partner - '2026-05-20' - 8484 - - partner - '2026-05-21' - 8484 - - partner - '2026-05-22' - 16968 - - partner - '2026-05-25' - 8484 - - partner - '2026-05-26' - 16968 - - partner - '2026-05-27' - 8484 - - partner - '2026-05-28' - 16968 - - public - '2026-05-06' - 19668 - - public - '2026-05-07' - 9834 - - public - '2026-05-10' - 19668 - - public - '2026-05-12' - 19668 - - public - '2026-05-14' - 19668 - - public - '2026-05-15' - 19668 - - public - '2026-05-17' - 9834 - - public - '2026-05-20' - 9834 - - public - '2026-05-21' - 9834 - - public - '2026-05-22' - 29502 - - public - '2026-05-24' - 9834 - - public - '2026-05-25' - 9834 - - public - '2026-05-26' - 9834 - - public - '2026-05-27' - 19668 - - public - '2026-05-28' - 19668 - - pvt-network - '2026-05-07' - 23022 - - pvt-network - '2026-05-09' - 7674 - - pvt-network - '2026-05-13' - 7674 - - pvt-network - '2026-05-15' - 7674 - - pvt-network - '2026-05-17' - 30696 - - pvt-network - '2026-05-20' - 7674 - - pvt-network - '2026-05-21' - 7674 - - pvt-network - '2026-05-22' - 7674 - - pvt-network - '2026-05-23' - 15348 - - pvt-network - '2026-05-24' - 15348 - - pvt-network - '2026-05-25' - 15348 - - pvt-network - '2026-05-26' - 7674 - - pvt-network - '2026-05-27' - 7674 - - pvt-network - '2026-05-28' - 23022 schema: columns: - description: Date bucket. type: DATE name: timestamp_date - description: Distribution channel (pvt-network, partner, public, etc.). type: STRING name: channel - description: Sum of workspace active actions on this date. type: INTEGER name: action_value getAnalyticsDataAPIDistributionActiveWorkspacesSummary: value: data: summary: schema: columns: - name: entity_count description: Distinct active workspace count across all distribution channels. type: INTEGER - name: change_percentage description: Percentage change vs previous period. type: FLOAT - name: change_type description: increase | decrease | no_change | new_data type: STRING rows: - - 31 - 3.3333333333333 - increase getAnalyticsDataAPIProductionFlowRunsDetailed: value: data: summary: schema: columns: - description: Flow entity identifier. name: entity_id type: STRING - description: Resolved flow display name. name: entity_name type: STRING - description: Sum of flow execution actions for this flow. name: action_value type: INTEGER rows: - - 688a38fee455890013be4293 - New flow module - 2374 - - 688a162be455890013be4242 - Generate personalized greeting response - 2374 - - 68b01c90ab62a6001365f3b1 - Payment Flow - 2374 - - 69f3a8fe43af796d09399272 - Test - 1966 pagination: has_more: true offset: 0 total: 7 limit: 3 getAnalyticsDataAPIProductionFlowRunsTrend: value: data: summary: rows: - - '2026-05-11' - 1966 - - '2026-05-15' - 1966 - - '2026-05-17' - 1966 - - '2026-05-19' - 408 - - '2026-05-20' - 408 - - '2026-05-21' - 1966 - - '2026-05-24' - 408 schema: columns: - name: timestamp_date type: DATE description: Date bucket. - name: action_value type: INTEGER description: Sum of flow execution actions on this date. getAnalyticsDataAPIProductionFlowRunsSummary: value: data: summary: schema: columns: - description: Distinct production flow count for the current period. name: entity_count type: INTEGER - description: Percentage change vs previous period. name: change_percentage type: FLOAT - description: increase | decrease | no_change | new_data name: change_type type: STRING rows: - - 4 - 100 - increase getAnalyticsDataAPIProductionMonitorRunsDetailed: value: data: summary: schema: columns: - name: entity_id description: Monitor entity identifier. type: STRING - name: entity_name description: Resolved monitor display name. type: STRING - name: action_value description: Sum of monitor run actions for this monitor. type: INTEGER rows: - - d80999e1-f3bb-468f-8c7d-acc215276f5f - Usage Monitor - 408 - - 98e7e8d7-1335-4bf3-bcdf-e72cf354690c - Integration Testing - 408 - - 243f42a3-81d8-42ab-9bb6-5a88f7e99362 - Uptime Monitor - 408 - - 08fa842a-73ab-4e8c-b8aa-2bd681cd0c18 - API - 408 - - 64b9d758-a81a-4bd7-aeae-54542ece5424 - Testing - 408 pagination: has_more: true limit: 5 offset: 0 total: 6 getAnalyticsDataAPIProductionMonitorRunsTrend: value: data: summary: rows: - - '2026-05-06' - 408 - - '2026-05-07' - 408 - - '2026-05-11' - 408 - - '2026-05-18' - 408 - - '2026-05-22' - 408 - - '2026-05-25' - 408 schema: columns: - name: timestamp_date type: DATE description: Date bucket. - name: action_value type: INTEGER description: Sum of monitor run actions on this date. getAnalyticsDataAPIProductionMonitorRunsSummary: value: data: summary: schema: columns: - description: Distinct entity count for the current period. name: entity_count type: INTEGER - description: Percentage change vs previous period. name: change_percentage type: FLOAT - description: increase | decrease | no_change | new_data name: change_type type: STRING rows: - - 6 - 20 - increase getAnalyticsDataAPITestingPerformanceTestRunsDetailed: value: data: summary: rows: - - 12345678-a06b31a7-8bf7-4bda-a6ec-f364d76cb9b5 - New Collection - 1046 - - 12345678-0c0905f9-caf8-47f0-a941-18a6a2a0ddd7 - Demo Testing - 1046 - - 56781234-1cf19e91-39bc-470f-a671-4dd6b3eff72b - Testing - 1046 - - 43215678-281f1bfb-e2fd-4dbf-86df-8190bcef8095 - New Collection - 1046 - - 12345678-2cde66bf-204a-4c83-84cb-cf61eba169b8 - API Testing - 1046 pagination: limit: 5 has_more: false offset: 0 total: 94 schema: columns: - name: entity_id type: STRING description: Collection entity identifier. - name: entity_name type: STRING description: Resolved collection display name. - name: run_count type: INTEGER description: Total test runs in the current period. getAnalyticsDataAPITestingPerformanceTestRunsTrend: value: data: summary: schema: columns: - name: timestamp_date description: Reporting date. type: DATE format: YYYY-MM-DD - name: type description: Run type (e.g. Performance Test). type: STRING - name: run_count description: Total test runs in the current period. type: INTEGER rows: - - '2026-05-06' - manual - 1046 - - '2026-05-06' - performance - 1046 - - '2026-05-07' - manual - 523 - - '2026-05-07' - performance - 523 - - '2026-05-08' - manual - 1046 - - '2026-05-08' - performance - 1046 - - '2026-05-09' - manual - 2092 - - '2026-05-09' - performance - 2092 - - '2026-05-10' - manual - 523 - - '2026-05-10' - performance - 523 - - '2026-05-11' - manual - 523 - - '2026-05-11' - performance - 523 - - '2026-05-12' - manual - 1046 - - '2026-05-12' - performance - 1046 - - '2026-05-13' - manual - 2092 - - '2026-05-13' - performance - 2092 - - '2026-05-15' - manual - 2615 - - '2026-05-15' - performance - 2615 - - '2026-05-16' - manual - 523 - - '2026-05-16' - performance - 523 - - '2026-05-17' - manual - 1046 - - '2026-05-17' - performance - 1046 - - '2026-05-19' - manual - 1569 - - '2026-05-19' - performance - 1569 - - '2026-05-20' - manual - 1046 - - '2026-05-20' - performance - 1046 - - '2026-05-21' - manual - 1046 - - '2026-05-21' - performance - 1046 - - '2026-05-22' - manual - 2092 - - '2026-05-22' - performance - 2092 - - '2026-05-24' - manual - 1046 - - '2026-05-24' - performance - 1046 - - '2026-05-25' - manual - 1569 - - '2026-05-25' - performance - 1569 - - '2026-05-26' - manual - 1569 - - '2026-05-26' - performance - 1569 - - '2026-05-27' - manual - 523 - - '2026-05-27' - performance - 523 - - '2026-05-28' - manual - 1046 - - '2026-05-28' - performance - 1046 getAnalyticsDataAPITestingPerformanceTestRunsSummary: value: data: summary: rows: - - 49162 - -14.034412813877 - decrease schema: columns: - name: run_count type: INTEGER description: Total test runs in the current period. - name: change_percentage type: FLOAT description: Percentage change in run count vs the previous period. - name: change_type type: STRING description: Direction of change (increase / decrease / new_data). getAnalyticsDataAPITestingFunctionalTestRunsDetailed: value: data: summary: schema: columns: - description: Collection entity identifier. type: STRING name: entity_id - description: Resolved collection display name. type: STRING name: entity_name - description: Total test runs in the current period. type: INTEGER name: run_count rows: - - 56781234-f92420a2-0dcb-44f3-b095-97acc0a9fd47 - New Collection - 12552 - - 43215678-06e27c7f-0804-40a8-a18c-1df5f87b47e6 - New Collection - 23012 - - 12345678-097c0264-2e8a-4a2c-8146-bf205664f272 - New Collection - 23012 - - 12345678-0c0905f9-caf8-47f0-a941-18a6a2a0ddd7 - Demo Test - 23012 - - 43215678-0ff97bf1-e18e-4261-83fc-f29b749099b5 - New Collection - 23012 pagination: limit: 5 offset: 0 has_more: true total: 2092 getAnalyticsDataAPITestingFunctionalTestRunsTrend: value: data: summary: schema: columns: - name: timestamp_date description: Reporting date. type: DATE format: YYYY-MM-DD - name: type description: Run type (e.g. Manual, Scheduled runs, Postman CLI, CI/CD, etc.). type: STRING - name: run_count description: Total test runs in the current period. type: INTEGER rows: - - '2026-05-06' - CI/CD - 32426 - - '2026-05-06' - CLI - 16213 - - '2026-05-06' - manual - 523 - - '2026-05-06' - scheduled - 5230 - - '2026-05-07' - CI/CD - 35564 - - '2026-05-07' - CLI - 17782 - - '2026-05-07' - manual - 2092 - - '2026-05-07' - scheduled - 5230 - - '2026-05-09' - CI/CD - 26150 - - '2026-05-09' - CLI - 13075 - - '2026-05-09' - manual - 523 - - '2026-05-09' - scheduled - 4184 - - '2026-05-10' - CI/CD - 53346 - - '2026-05-10' - CLI - 26673 - - '2026-05-10' - manual - 1569 - - '2026-05-10' - scheduled - 8368 - - '2026-05-11' - CI/CD - 40794 - - '2026-05-11' - CLI - 20397 - - '2026-05-11' - manual - 1569 - - '2026-05-11' - scheduled - 6276 - - '2026-05-12' - CI/CD - 32426 - - '2026-05-12' - CLI - 16213 - - '2026-05-12' - manual - 523 - - '2026-05-12' - scheduled - 5230 - - '2026-05-13' - CI/CD - 19874 - - '2026-05-13' - CLI - 9937 - - '2026-05-13' - manual - 523 - - '2026-05-13' - scheduled - 3138 - - '2026-05-14' - CI/CD - 27196 - - '2026-05-14' - CLI - 13598 - - '2026-05-14' - manual - 1046 - - '2026-05-14' - scheduled - 4184 - - '2026-05-15' - CI/CD - 28242 - - '2026-05-15' - CLI - 14121 - - '2026-05-15' - manual - 1569 - - '2026-05-15' - scheduled - 4184 - - '2026-05-16' - CI/CD - 20920 - - '2026-05-16' - CLI - 10460 - - '2026-05-16' - manual - 1046 - - '2026-05-16' - scheduled - 3138 - - '2026-05-17' - CI/CD - 40794 - - '2026-05-17' - CLI - 20397 - - '2026-05-17' - manual - 1569 - - '2026-05-17' - scheduled - 6276 - - '2026-05-18' - CI/CD - 12552 - - '2026-05-18' - CLI - 6276 - - '2026-05-18' - scheduled - 2092 - - '2026-05-19' - CI/CD - 42886 - - '2026-05-19' - CLI - 21443 - - '2026-05-19' - manual - 2615 - - '2026-05-19' - scheduled - 6276 - - '2026-05-20' - CI/CD - 28242 - - '2026-05-20' - CLI - 14121 - - '2026-05-20' - manual - 1569 - - '2026-05-20' - scheduled - 4184 - - '2026-05-21' - CI/CD - 13598 - - '2026-05-21' - CLI - 6799 - - '2026-05-21' - manual - 523 - - '2026-05-21' - scheduled - 2092 - - '2026-05-22' - CI/CD - 13598 - - '2026-05-22' - CLI - 6799 - - '2026-05-22' - manual - 523 - - '2026-05-22' - scheduled - 2092 - - '2026-05-23' - CI/CD - 41840 - - '2026-05-23' - CLI - 20920 - - '2026-05-23' - manual - 2092 - - '2026-05-23' - scheduled - 6276 - - '2026-05-24' - CI/CD - 12552 - - '2026-05-24' - CLI - 6276 - - '2026-05-24' - scheduled - 2092 - - '2026-05-25' - CI/CD - 34518 - - '2026-05-25' - CLI - 17259 - - '2026-05-25' - manual - 1569 - - '2026-05-25' - scheduled - 5230 - - '2026-05-26' - CI/CD - 39748 - - '2026-05-26' - CLI - 19874 - - '2026-05-26' - manual - 1046 - - '2026-05-26' - scheduled - 6276 - - '2026-05-27' - CI/CD - 20920 - - '2026-05-27' - CLI - 10460 - - '2026-05-27' - manual - 1046 - - '2026-05-27' - scheduled - 3138 - - '2026-05-28' - CI/CD - 28242 - - '2026-05-28' - CLI - 14121 - - '2026-05-28' - manual - 1569 - - '2026-05-28' - scheduled - 4184 getAnalyticsDataAPITestingFunctionalTestRunsSummary: value: data: summary: schema: columns: - name: run_count description: Total test runs in the current period. type: INTEGER - name: change_percentage description: Percentage change in run count vs the previous period. type: FLOAT - name: change_type description: Direction of change (increase / decrease / new_data). type: STRING rows: - - 1094116 - -22.061962006742 - decrease getAnalyticsDataAPITestingRunsTrend: value: data: summary: schema: columns: - format: YYYY-MM-DD description: Date Bucket. name: timestamp_date type: DATE - description: Total test runs in the current period. name: run_count type: INTEGER rows: - - collection-runner - '2026-05-06' - 54392 - - collection-runner - '2026-05-07' - 60668 - - collection-runner - '2026-05-09' - 43932 - - collection-runner - '2026-05-10' - 89956 - - collection-runner - '2026-05-11' - 69036 - - collection-runner - '2026-05-12' - 54392 - - collection-runner - '2026-05-13' - 33472 - - collection-runner - '2026-05-14' - 46024 - - collection-runner - '2026-05-15' - 48116 - - collection-runner - '2026-05-16' - 35564 - - collection-runner - '2026-05-17' - 69036 - - collection-runner - '2026-05-18' - 20920 - - collection-runner - '2026-05-19' - 73220 - - collection-runner - '2026-05-20' - 48116 - - collection-runner - '2026-05-21' - 23012 - - collection-runner - '2026-05-22' - 23012 - - collection-runner - '2026-05-23' - 71128 - - collection-runner - '2026-05-24' - 20920 - - collection-runner - '2026-05-25' - 58576 - - collection-runner - '2026-05-26' - 66944 - - collection-runner - '2026-05-27' - 35564 - - collection-runner - '2026-05-28' - 48116 - - performance-test - '2026-05-06' - 2092 - - performance-test - '2026-05-07' - 1046 - - performance-test - '2026-05-08' - 2092 - - performance-test - '2026-05-09' - 4184 - - performance-test - '2026-05-10' - 1046 - - performance-test - '2026-05-11' - 1046 - - performance-test - '2026-05-12' - 2092 - - performance-test - '2026-05-13' - 4184 - - performance-test - '2026-05-15' - 5230 - - performance-test - '2026-05-16' - 1046 - - performance-test - '2026-05-17' - 2092 - - performance-test - '2026-05-19' - 3138 - - performance-test - '2026-05-20' - 2092 - - performance-test - '2026-05-21' - 2092 - - performance-test - '2026-05-22' - 4184 - - performance-test - '2026-05-24' - 2092 - - performance-test - '2026-05-25' - 3138 - - performance-test - '2026-05-26' - 3138 - - performance-test - '2026-05-27' - 1046 - - performance-test - '2026-05-28' - 2092 getAnalyticsDataAPITestingRunsSummary: value: data: summary: rows: - - 1143278 - -21.747742666747 - decrease schema: columns: - name: run_count type: INTEGER description: Total test runs in the current period. - name: change_percentage type: FLOAT description: Percentage change vs previous period. - name: change_type type: STRING description: increase | decrease | no_change | new_data getAnalyticsDataAPIDevelopmentTopEntitiesDetailed: value: data: summary: schema: columns: - name: entity_type type: STRING description: 'Type of entity. eg: collection, flow, mock, specification, sdk' - name: entity_id type: STRING description: 'Unique identifier of the entity. eg: collection_id, flow_id, mock_id, specification_id, sdk_id.' - name: entity_name type: STRING description: Resolved display name of the entity. - name: action_value type: INTEGER description: Sum of actions performed on the entity. rows: - - collection - 12345678-339e1dad-f484-423d-933a-ab48a0155fb3 - Mock API Fork - 10602 - - collection - 43215678-f92420a2-0dcb-44f3-b095-97acc0a9fd47 - New Collection - 9234 - - collection - 56781234-366d9d8d-0643-4ca9-b178-a2c0c2b1bb4e - Test - 7578 - - collection - 12345678-59de5a7b-ec51-49c7-b434-d1ac178e83cc - API Test - 4092 - - collection - 12345678-62308792-93e7-414a-ad9d-be5e4aea33b2 - Live Session - 3272 pagination: total: 5 limit: 100 offset: 0 has_more: true getAnalyticsDataAPIDevelopmentEntityActivityDetailed: value: data: summary: schema: columns: - name: entity_type type: STRING description: 'Type of entity. eg: collection, flow, mock, specification, sdk' - name: entity_id type: STRING description: 'Unique identifier of the entity. eg: collection_id, flow_id, mock_id, specification_id, sdk_id' - name: entity_name type: STRING description: Display name of the entity (resolved from view_entity_id_name_mapping). - name: action_value type: INTEGER description: Total number of actions performed on the entity. rows: - - collection - 12345678-366d9d8d-0643-4ca9-b178-a2c0c2b1bb4e - Testing - 7578 - - collection - 56781234-59de5a7b-ec51-49c7-b434-d1ac178e83cc - API Test - 4092 - - collection - 12345678-62308792-93e7-414a-ad9d-be5e4aea33b2 - Live Session - 3272 - - collection - 43215678-0a87e0ba-0b84-44fd-b72f-b8eaf830aa58 - API network - 2238 - - collection - 12345678-e290f053-c047-45e9-a25d-9030f1d6997c - Feature Usage colleciton - 2160 pagination: total: 18 limit: 5 offset: 0 has_more: true getAnalyticsDataAPIDevelopmentEntityActivityTrend: value: data: summary: schema: columns: - name: timestamp_date type: DATE format: YYYY-MM-DD description: Reporting date. - name: entity_count type: INTEGER description: Distinct number of active entities of the requested type on this date. rows: - - '2026-01-01' - 1 - - '2026-02-01' - 3 - - '2026-03-01' - 5 - - '2026-04-01' - 5 - - '2026-05-01' - 4 getAnalyticsDataAPIDevelopmentEntityActivitySummary: value: data: summary: schema: columns: - name: entity_count type: INTEGER description: Number of distinct active entities of the requested type in the current period. - name: change_percentage type: FLOAT description: Percentage change in entity count vs the previous period. - name: change_type type: STRING description: Direction of change (increase / decrease / new_data). rows: - - 7 - 16.666666666666664 - increase getAnalyticsDataAPIDevelopmentActiveWorkspacesTrend: value: data: summary: schema: columns: - name: timestamp_date description: Reporting date. type: DATE format: YYYY-MM-DD - name: workspace_count description: Distinct number of workspaces with API development activity on this date. type: INTEGER rows: - - '2026-05-06' - 11 - - '2026-05-07' - 11 - - '2026-05-08' - 11 - - '2026-05-09' - 10 - - '2026-05-10' - 11 - - '2026-05-11' - 12 - - '2026-05-12' - 10 - - '2026-05-13' - 10 - - '2026-05-14' - 10 - - '2026-05-15' - 12 - - '2026-05-16' - 10 - - '2026-05-17' - 11 - - '2026-05-18' - 10 - - '2026-05-19' - 11 - - '2026-05-20' - 11 - - '2026-05-21' - 11 - - '2026-05-22' - 12 - - '2026-05-23' - 11 - - '2026-05-24' - 11 - - '2026-05-25' - 10 - - '2026-05-26' - 11 - - '2026-05-27' - 10 - - '2026-05-28' - 11 - - '2026-05-29' - 11 - - '2026-05-30' - 12 - - '2026-05-31' - 11 - - '2026-06-01' - 10 - - '2026-06-02' - 12 - - '2026-06-03' - 12 - - '2026-06-04' - 12 getAnalyticsDataAPIDevelopmentActiveWorkspacesSummary: value: data: summary: rows: - - 13 - 0 - no_change schema: columns: - description: Number of workspaces with API development activity in the current period. type: INTEGER name: workspace_count - description: Percentage change in workspace count vs the previous period. type: FLOAT name: change_percentage - description: Direction of change (increase / decrease / new_data). type: STRING name: change_type analytics400ErrorInvalidResourceMetricPair: value: type: https://api.postman.com/problems/bad-request title: Malformed request status: 400 detail: view='detailed' is not supported for resource 'workspaces' metric 'elements_in_workspace'. analytics400ErrorInvalidMetric: value: type: https://api.postman.com/problems/bad-request title: Malformed request status: 400 detail: metric='wrong_metric_name' is not supported for resource 'workspaces'. analytics401Error: value: type: https://api.postman.com/problems/unauthorized title: Unauthorized detail: Unauthorized status: 401 instance: /analytics analytics403Error: value: type: https://api.postman.com/problems/forbidden title: AuthenticationError detail: Invalid API Key. Every request requires a valid API Key to be sent. status: 403 instance: /analytics getAnalyticsMetadataSuccessfulResponse: value: data: resources: - metrics: - metric: active_users description: Users who used postman at least once. - metric: workspace_active_users description: Users who created, edited or sent requests within an individual workspace. resource: user description: User-level metrics and insights describing activities and engagement within Postman workspaces. - metrics: - metric: elements_in_workspace description: Total count of workspace elements (collections, environments, mocks and monitors) over time. - metric: active_workspaces description: List of active workspaces in the selected period based on edits and API requests sent. - metric: api_calls description: Aggregated API call counts across workspaces. - metric: active_collections description: List of collections that have been edited or used to send API requests. - metric: response_status description: Breakdown of API response codes (2xx, 4xx, 5xx) over time. - metric: pending_invites description: List of pending workspace invitations including target email addresses and invite timestamps. - metric: needs_attention description: Identifies partners or users needing attention (e.g., no successful requests or high error rates) for proactive support. - metric: success_rate description: Percentage of successful responses (2xx) over time - metric: user_requests description: Request-level data for individual users including request names, collections, response statuses and timestamps. - metric: collection_error_aggregate description: Aggregated error metrics (4xx, 5xx responses) per collection, helping identify collections with the highest error rates. resource: workspace description: Workspace-level metrics and insights about activities and collaboration patterns - metrics: - metric: user_api_journey description: Tracks user progression through the API adoption funnel, showing active users, API users, new API users, successful users, and error-only users. Helps teams understand user onboarding effectiveness and identify users needing support. - metric: workspace_distribution description: Distribution of workspace types (team, private, partner, public) over time. - metric: internal_workspace_distribution description: Distribution of internal workspaces created into team-shared and private categories. - metric: license_consumption description: Tracks how licenses are used across roles (members, partners, guests) and identifies unused seats. - metric: members description: Detailed team member list including profile, role and invitation metadata. - metric: members_overtime description: Monthly trend of the total team member count over the selected duration. Useful for tracking team growth or contraction over time. - metric: member_invites description: Monthly trend of team member invites, showing how many invites were sent and accepted each month over the selected duration. - metric: invites_sent description: Detailed list of member invites sent. Pair with `filter[period]=YYYY-MM` for a specific month or `filter[period]=YYYY-MM-DD` for a specific day; when omitted, all invites for the team are returned (subject to pagination). - metric: invites_accepted description: Detailed list of member invites accepted. Pair with `filter[period]=YYYY-MM` for a specific month or `filter[period]=YYYY-MM-DD` for a specific day; when omitted, all accepted invites for the team are returned (subject to pagination). - metric: last_autoflex_cycle description: Detailed team members captured in the most recent AutoFlex billing cycle. - metric: partner_engagement_funnel description: Partner engagement funnel, providing insights into partner activation and onboarding. Helps organizations measure the effectiveness of their partner programs and identify engagement opportunities. resource: team description: Team-level metrics and insights on team activity, license consumption, and organizational workspace trends - metrics: - metric: agent_mode_users description: The number of users across your workspaces who run at least one query using Agent Mode over the selected period of time. Use view=summary for a single-record rollup over the duration, or view=trend for a time series. - metric: messages_sent description: Number of messages sent by the user to the agent. Use view=summary for a single-record rollup over the duration, or view=trend for a time series. - metric: agent_mode_sessions description: The number of Agent Mode sessions across your workspaces over the selected period of time. An Agent Mode session starts when a user sends a message using Agent Mode. Use view=summary for a single-record rollup over the duration, or view=trend for a time series. - metric: new_vs_returning_users description: Breakdown of active users by new and returning users for that time period. - metric: credit_usage_by_model description: AI credits used by each model over time. - metric: top_agent_models_by_usage description: Top Agent Mode models ranked by total credits used. Use view=detailed for a paginated model ranking for that time period. - metric: peak_activity description: Identifies the peak activity period by credit consumption. - metric: activity_distribution description: Distribution of Agent Mode activity across time buckets. - metric: credit_usage description: The number of AI credits used in the current billing cycle across your workspaces. This metric isn't affected by the date range filters. - metric: usage_leaderboard description: Leaderboard of users ranked by Agent Mode usage by total credits used. Use view=summary for the top 10 users, or view=detailed for a paginated ranking. resource: ai description: Reports about Agent Mode usage across workspaces covering user activity, model usage and credit consumption patterns - metrics: - metric: active_workspaces description: Number of workspaces with API development activity over the selected period, with change percentage. - metric: entity_activity description: Active entity count by type (collection, flow, mock, specification, sdk) with change percentage and detailed breakdown. - metric: top_entities description: Top entities ranked by action count for a given entity type. resource: api_development description: API development activity metrics — workspace counts, entity activity by type (collection, flow, mock, specification, sdk), and top entities. - metrics: - metric: runs description: Total test run count across all sources with change percentage. - metric: functional_test_runs description: Functional test runs via collection-runner (Manual, Scheduled, Postman CLI, CI/CD). - metric: performance_test_runs description: Performance test run counts with change percentage and top tested collections. resource: api_testing description: API testing metrics — total test runs, functional test runs (collection-runner), and performance test runs. - metrics: - metric: monitor_runs description: Monitor run activity — active monitor count, run volume over time, and top monitors. - metric: flow_executions description: Production flow execution activity — active flow count, execution volume over time, and top flows. resource: api_production description: API production metrics — monitor run activity and production flow execution activity. - metrics: - metric: active_workspaces description: Active workspace count across all distribution channels with trend broken down by channel. - metric: pvt_network description: Private API Network workspace activity — count with change percentage and top workspaces. - metric: partner description: Partner Network workspace activity — count with change percentage and top workspaces. - metric: public description: Public API Network workspace activity — count with change percentage and top workspaces. resource: api_distribution description: API distribution metrics — active workspace counts across distribution channels (pvt-network, partner, public). - metrics: - metric: workspace_activity description: Active workspace count for API management with trend over time and top workspaces. resource: api_management description: API management metrics — workspace activity for API management including active counts, trends, and top workspaces. description: Metadata for analytics APIs delivering usage, success, workspace and team trend insights in Postman getAnalyticsMetadataFitlerResultsByMetrics: value: data: resources: - metrics: - description: List of active workspaces in the selected period based on edits and API requests sent. metric: active_workspaces resource: workspace description: Workspace-level metrics and insights about activities and collaboration patterns - metrics: - description: Tracks how licenses are used across roles (members, partners, guests) and identifies unused seats. metric: license_consumption resource: team description: Team-level metrics and insights on team activity, license consumption, and organizational workspace trends description: Metadata for analytics APIs delivering usage, success, workspace and team trend insights in Postman getAnalyticsMetadataFitlerResultsByTeamResource: value: data: description: Metadata for analytics APIs delivering usage, success, workspace and team trend insights in Postman resources: - resource: team description: Team-level metrics and insights on team activity, license consumption, and organizational workspace trends metrics: - metric: user_api_journey description: Tracks user progression through the API adoption funnel, showing active users, API users, new API users, successful users, and error-only users. Helps teams understand user onboarding effectiveness and identify users needing support. - metric: workspace_distribution description: Distribution of workspace types (team, private, partner, public) over time. - metric: internal_workspace_distribution description: Distribution of internal workspaces created into team-shared and private categories. - metric: license_consumption description: Tracks how licenses are used across roles (members, partners, guests) and identifies unused seats. - metric: members description: Detailed team member list including profile, role and invitation metadata. - metric: last_autoflex_cycle description: Detailed team members captured in the most recent AutoFlex billing cycle. - metric: partner_engagement_funnel description: Partner engagement funnel, providing insights into partner activation and onboarding. Helps organizations measure the effectiveness of their partner programs and identify engagement opportunities. getAnalyticsMetadataFitlerResultsByResourceWithParametersAndResponseData: value: data: resources: - type: string metrics: - metric: active_users type: string response: detailed: schema: columns: - name: user_id description: Unique identifier assigned to the user. type: STRING - name: team_joining_date description: Date when the user joined the team. type: DATE - name: last_active_ts description: Timestamp of the user's most recent activity. type: TIMESTAMP format: YYYY-MM-DDTHH:MM:SSZ - name: api_requests_count description: Total number of API requests made by the user. type: INTEGER - name: system_actions_count description: Total number of system actions made by the user. type: INTEGER - name: primary_tasks description: Primary tasks made by the user. type: STRING summary: schema: columns: - name: count description: Total number of active users in the selected period. type: INTEGER - name: change description: Percentage change from the previous period. type: FLOAT - name: change_type description: Indicates whether the metric increased or decreased. type: STRING description: Users who used postman at least once. parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether the metric returns detailed or summarized data. allowed_values: - detailed - summary isRequired: false filters: workspace_type: type: ENUM allowed_values: - internal - public - partner isRequired: true duration: type: ENUM allowed_values: - last_month isRequired: true isRequired: true - metric: workspace_active_users type: string response: summary: schema: columns: - name: count description: Summarized total count. type: INTEGER description: Users who created, edited or sent requests within an individual workspace. parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether the metric returns detailed or summarized data. allowed_values: - summary isRequired: false filters: workspace_type: type: ENUM allowed_values: - internal - public - partner isRequired: true duration: type: ENUM allowed_values: - last_month isRequired: true isRequired: true description: User-level metrics and insights describing activities and engagement within Postman workspaces. resource: user isRequired: true - type: string metrics: - metric: elements_in_workspace type: string response: summary: schema: columns: - name: timestamp description: Reporting date for the metric. type: DATE format: YYYY-MM-DD - name: collections_count description: Number of collections in the selected period. type: INTEGER - name: environments_count description: Number of environments in the selected period. type: INTEGER - name: mocks_count description: Number of mocks in the selected period. type: INTEGER - name: monitors_count description: Number of monitors in the selected period. type: INTEGER description: Total count of workspace elements (collections, environments, mocks and monitors) over time. parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether detailed data is returned for this metric. allowed_values: - summary isRequired: false filters: workspace_type: type: ENUM allowed_values: - internal - public - partner isRequired: true duration: type: ENUM allowed_values: - last_month - last_6_months isRequired: true isRequired: true - metric: active_workspaces type: string response: detailed: schema: columns: - name: is_hidden description: Indicates whether the workspace is hidden from the user. type: BOOLEAN - name: workspace_name description: Display name of the workspace. type: STRING - name: workspace_id description: Unique identifier for the workspace. type: STRING - name: created_by description: Name of the user who created the workspace type: STRING - name: type description: Visibility type of the workspace such as Internal, Partner or Public type: STRING - name: contributors description: Number of contributors to the workspace. type: INTEGER - name: api_calls description: Number of API requests sent in the workspace. type: INTEGER summary: schema: columns: - name: count description: Summarized total count. type: INTEGER - name: change description: Percentage or numeric change from the previous period. type: FLOAT - name: change_type description: Indicates whether the change is an increase or decrease. type: STRING description: List of active workspaces in the selected period based on edits and API requests sent. parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether detailed or summarized data is returned for this metric. allowed_values: - detailed - summary isRequired: false filters: workspace_type: type: ENUM allowed_values: - internal - public - partner isRequired: true duration: type: ENUM allowed_values: - last_month isRequired: true isRequired: true - metric: api_calls type: string response: summary: schema: columns: - name: count description: Summarized total count. type: INTEGER - name: change description: Percentage or numeric change from the previous period. type: FLOAT - name: change_type description: Indicates whether the change is an increase or decrease. type: STRING description: Aggregated API call counts across workspaces. parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether detailed or summarized data is returned for this metric. allowed_values: - summary isRequired: false filters: workspace_type: type: ENUM allowed_values: - internal - public - partner isRequired: true duration: type: ENUM allowed_values: - last_month isRequired: true isRequired: true - metric: active_collections type: string response: detailed: schema: columns: - name: is_hidden description: Indicates whether the collection is hidden from the user. type: BOOLEAN - name: collection_id description: Unique identifier for the collection. type: STRING - name: collection_name description: Display name of the collection. type: STRING - name: workspace_name description: Name of the workspace containing the collection. type: STRING - name: created_by description: Name of the user who created the collection. type: STRING - name: api_calls_count description: Total number of API calls made using requests in this collection. type: INTEGER description: List of collections that have been edited or used to send API requests. parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether detailed or summarized data is returned for this metric. allowed_values: - detailed isRequired: false filters: workspace_type: type: ENUM allowed_values: - internal - public - partner isRequired: true duration: type: ENUM allowed_values: - last_month isRequired: true isRequired: true - metric: response_status type: string response: summary: schema: columns: - name: timestamp description: Reporting date for the metric. type: DATE format: YYYY-MM-DD - name: total_count description: Total number of API requests for the selected period. type: INTEGER - name: count_2xx description: Number of successful API responses (2xx). type: INTEGER - name: count_3xx description: Number of redirection responses (3xx). type: INTEGER - name: count_4xx description: Number of client error responses (4xx). type: INTEGER - name: count_5xx description: Number of server error responses (5xx). type: INTEGER description: Breakdown of API response codes (2xx, 4xx, 5xx) over time. parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether detailed or summarized data is returned for this metric. allowed_values: - summary isRequired: false filters: workspace_type: type: ENUM allowed_values: - internal - public - partner isRequired: true duration: type: ENUM allowed_values: - last_month - last_6_months isRequired: true isRequired: true - metric: pending_invites type: string response: detailed: schema: columns: - name: email_id description: Invitee's target email. type: STRING - name: invite_id description: Unique identifier for the invite. type: STRING - name: timestamp description: Timestamp when the invite was created. type: TIMESTAMP format: YYYY-MM-DDTHH:MM:SSZ summary: schema: columns: - name: count description: Number of pending invites. type: INTEGER description: List of pending workspace invitations including target email addresses and invite timestamps. parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether detailed or summarized data is returned for this metric. allowed_values: - summary - detailed isRequired: false filters: [] isRequired: true - metric: needs_attention type: string response: summary: schema: columns: - name: count description: Number of partners who need attention. type: INTEGER detailed: schema: columns: - name: user_id description: Unique identifier of the user. type: STRING - name: request_type description: Type of issue or request pattern detected for the user. type: STRING - name: timestamp description: Timestamp when the request event was recorded. type: TIMESTAMP format: YYYY-MM-DDTHH:MM:SSZ - name: request_name description: Display name of the request. Present when request_type = no_success_on_tried_request. type: STRING - name: request_identifier_id description: Unique identifier for the request. Present when request_type = no_success_on_tried_request. type: STRING description: Identifies partners or users needing attention (e.g., no successful requests or high error rates) for proactive support. parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether detailed or summarized data is returned for this metric. allowed_values: - summary - detailed isRequired: false filters: duration: type: ENUM allowed_values: - last_30_days isRequired: true attention_type: type: ENUM description: Filter by the attention category. allowed_values: - no_success_on_tried_request - high_non_200OK_rate_for_partner isRequired: false isRequired: true - metric: success_rate type: string response: summary: schema: columns: - name: success_rate description: Overall percentage of successful requests. type: FLOAT - name: change description: Change in success rate compared to the previous period. type: FLOAT - name: change_type description: Indicates whether the success rate increased or decreased. type: STRING detailed: schema: columns: - name: request_name description: Human-readable name of the request. type: STRING - name: request_id description: Unique identifier for the specific request definition. type: STRING - name: collection_name description: Name of the collection containing the request. type: STRING - name: success_count description: Number of successful responses received. type: INTEGER - name: total_requests description: Number of API requests sent. type: INTEGER description: Percentage of successful responses (2xx) over time parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether detailed or summarized data is returned. allowed_values: - summary - detailed isRequired: false filters: duration: type: ENUM allowed_values: - last_30_days isRequired: true isRequired: true - metric: user_requests type: string response: detailed: schema: columns: - name: user_id description: Unique identifier of the user who sent the request. type: STRING - name: request_name description: Human-readable name of the request made by the user. type: STRING - name: request_id description: Unique identifier of the specific request sent. type: STRING - name: collection_name description: Name of the collection containing the request. type: STRING - name: collection_id description: Unique Identifier of the collection containing the request. type: STRING - name: workspace_id description: Unique Identifier of the workspace containing the collection. type: STRING - name: response_status description: HTTP response code returned for the request. type: INTEGER - name: request_ts description: Timestamp when the request was made. type: TIMESTAMP format: YYYY-MM-DDTHH:MM:SSZ description: Request-level data for individual users including request names, collections, response statuses and timestamps. parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether detailed or summarized data is returned for this metric. allowed_values: - detailed isRequired: false filters: duration: type: ENUM allowed_values: - last_180_days isRequired: true response_status: type: STRING description: Filter by the response status code. isRequired: false user_id: type: STRING description: Filter by the user's unique identifier isRequired: false request_id: type: STRING description: Filter by the request's unique identifier. isRequired: false isRequired: true - metric: collection_error_aggregate type: string response: detailed: schema: columns: - name: is_hidden description: Indicates whether the collection is hidden from the user. type: BOOLEAN - name: collection_id description: Unique identifier for the collection. type: STRING - name: collection_name description: Name of the collection. type: STRING - name: workspace_id description: Unique identifier of the workspace containing the collection. type: STRING - name: count_4xx description: Number of 4xx responses for the collection in the selected period. type: INTEGER - name: count_5xx description: Number of 5xx responses for the collection in the selected period. type: INTEGER - name: total_api_calls description: Number of API calls for the collection in the selected period. type: INTEGER description: Aggregated error metrics (4xx, 5xx responses) per collection, helping identify collections with the highest error rates. parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether detailed or summarized data is returned for this metric. allowed_values: - detailed isRequired: false filters: duration: type: ENUM allowed_values: - last_month - last_6_months isRequired: true isRequired: true description: Workspace-level metrics and insights about activities and collaboration patterns resource: workspace isRequired: true - type: string metrics: - metric: user_api_journey type: string response: summary: schema: columns: - name: timestamp description: Reporting date for aggregated user activity metrics. type: DATE format: YYYY-MM-DD - name: active_user description: Number of users active in the selected date. type: INTEGER - name: api_user description: Number of users who made at least one API call. type: INTEGER - name: new_api_user description: Number of users making API calls for the first time. type: INTEGER - name: successful description: Number of users whose API calls were mostly successful. type: INTEGER - name: error_only description: Number of users who encountered only error responses. type: INTEGER description: Tracks user progression through the API adoption funnel, showing active users, API users, new API users, successful users, and error-only users. Helps teams understand user onboarding effectiveness and identify users needing support. parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether detailed or summarized data is returned for this metric. allowed_values: - summary isRequired: false filters: workspace_type: type: ENUM allowed_values: - internal - public - partner isRequired: true duration: type: ENUM allowed_values: - last_month - last_6_months isRequired: true isRequired: true - metric: workspace_distribution type: string response: summary: schema: columns: - name: date description: Reporting date for the aggregated workspace counts. type: DATE format: YYYY-MM-DD - name: total description: Number of workspaces for the given date. type: INTEGER - name: internal description: Number of internal workspaces. type: INTEGER - name: partner description: Number of partner workspaces. type: INTEGER - name: public description: Number of public workspaces. type: INTEGER description: Distribution of workspace types (team, private, partner, public) over time. parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether detailed or summarized data is returned for this metric. allowed_values: - summary isRequired: false filters: workspace_type: type: ENUM allowed_values: - internal - public - partner isRequired: true duration: type: ENUM allowed_values: - last_month - last_6_months isRequired: true isRequired: true - metric: internal_workspace_distribution type: string response: summary: schema: columns: - name: date description: Reporting date for internal workspace distribution. type: DATE format: YYYY-MM-DD - name: internal_team_shared description: Count of internal team-shared workspaces. type: INTEGER - name: internal_private description: Count of internal private workspaces. type: INTEGER description: Distribution of internal workspaces created into team-shared and private categories. parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether detailed or summarized data is returned for this metric. allowed_values: - summary isRequired: false filters: workspace_type: type: ENUM allowed_values: - internal - public - partner isRequired: true duration: type: ENUM allowed_values: - last_6_months isRequired: true isRequired: true - metric: license_consumption type: string response: summary: schema: columns: - name: date description: Reporting date for team and license metrics. type: DATE format: YYYY-MM-DD - name: team_members description: Total number of team members. type: INTEGER - name: active_postman_users description: Number of team members actively using Postman. type: INTEGER - name: partners description: Number of partner users invited to the team. type: INTEGER - name: guests description: Number of guest users in the team. type: INTEGER - name: unused_licenses description: Number of unused team member licenses. type: INTEGER description: Tracks how licenses are used across roles (members, partners, guests) and identifies unused seats. parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether detailed or summarized data is returned for this metric. allowed_values: - summary isRequired: false filters: workspace_type: type: ENUM allowed_values: - internal - public - partner isRequired: true duration: type: ENUM allowed_values: - last_6_months isRequired: true isRequired: true - metric: members type: string response: detailed: schema: columns: - name: user_name description: User's name. type: STRING - name: email description: Email ID of user. type: STRING - name: added_in_team description: Timestamp when user was added to team. type: DATE - name: last_active description: Timestamp when user was last active. type: DATE - name: user_role description: Concatenated list of roles that user has. type: STRING - name: invited_by description: Email ID that invited this user. type: STRING - name: invite_type description: Type of invitation. type: STRING - name: public_profile_enabled description: Describes whether the user's public profile is enabled or not. type: STRING description: Detailed team member list including profile, role and invitation metadata. parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether detailed or summarized data is returned for this metric. allowed_values: - detailed isRequired: false filters: [] isRequired: true - metric: last_autoflex_cycle type: string response: detailed: schema: columns: - name: name description: User's name. type: STRING - name: email description: Email ID of user. type: STRING - name: last_active description: Timestamp when user was last active. type: DATE - name: invited_by description: Email ID that invited this user. type: STRING - name: joined_date description: Timestamp when user joined team. type: DATE - name: user_role description: Concatenated list of roles that user has. type: STRING description: Detailed team members captured in the most recent AutoFlex billing cycle. parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether detailed or summarized data is returned for this metric. allowed_values: - detailed isRequired: false filters: [] isRequired: true - metric: partner_engagement_funnel type: string response: summary: schema: columns: - name: metric description: Name of the partner engagement metric. type: STRING - name: count description: Value associated with the specific engagement metric. type: INTEGER detailed: description: 'Returns data grouped by funnel stages: all_partners, workspace_visited, viewed_collection, request_sent, successful_requests_200OK. Each stage contains a list of partners who reached that stage.' funnel_stages: - all_partners - workspace_visited - viewed_collection - request_sent - successful_requests_200OK schema: columns: - name: user_id description: Unique identifier of the partner user. type: STRING - name: timestamp description: Timestamp when the partner activity was recorded. type: TIMESTAMP format: YYYY-MM-DDTHH:MM:SSZ description: Partner engagement funnel, providing insights into partner activation and onboarding. Helps organizations measure the effectiveness of their partner programs and identify engagement opportunities. parameters: pagination: supported: true allowed_values: - offset - limit view: type: ENUM description: Determines whether detailed or summarized data is returned for this metric. allowed_values: - summary - detailed isRequired: false filters: duration: type: ENUM allowed_values: - last_180_days isRequired: true isRequired: true description: Team-level metrics and insights on team activity, license consumption, and organizational workspace trends resource: team isRequired: true description: Metadata for analytics APIs delivering usage, success, workspace and team trend insights in Postman getApiCatalogDiscoveryServicesSuccessfulResponse: value: meta: total: 5 nextCursor: null data: - id: 0eac9b7d-0603-4f16-8a4a-76c78df8fe26 name: Supply - stage (1.0.1) version: 1.0.1 sourceEnvironment: stage systemEnvironmentId: null status: discovered endpointsCount: 6 discoverySource: api_gateway_app tags: [] discoveredAt: '2026-02-12T04:01:26.000Z' - id: 0eab2aa4-d39b-49eb-a17b-d6c7b7eb9c9d name: Order - stage (3.0.0) version: 3.0.0 sourceEnvironment: stage systemEnvironmentId: null status: discovered endpointsCount: 2 discoverySource: api_gateway_app tags: [] discoveredAt: '2026-02-12T04:01:26.000Z' - id: a6aa80f3-bc34-4314-abc4-22c4fc5fd15d name: Jelly Bean Wiki (IBM - 9) - sandbox (1.0.0) version: 1.0.0 sourceEnvironment: sandbox systemEnvironmentId: null status: discovered endpointsCount: 3 discoverySource: api_gateway_app tags: [] discoveredAt: '2026-02-12T04:01:26.000Z' - id: 5f5bda12-63e2-47d2-8824-ed5889de571a name: Jelly Bean Wiki (IBM - 8) - sandbox (1.0.0) version: 1.0.0 sourceEnvironment: sandbox systemEnvironmentId: null status: discovered endpointsCount: 3 discoverySource: api_gateway_app tags: [] discoveredAt: '2026-02-12T04:01:26.000Z' - id: 339f3be5-0a91-47d5-a8c3-90d644752f5e name: Jelly Bean Wiki (IBM - 7) - sandbox (1.0.0) version: 1.0.0 sourceEnvironment: null systemEnvironmentId: null status: discovered endpointsCount: 3 discoverySource: api_gateway_app tags: [] discoveredAt: '2026-02-12T04:01:26.000Z' getApiCatalogDiscoveryServicesFilterByStatus: value: meta: total: 7 nextCursor: null data: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 name: Supply - stage (1.0.1) version: 1.0.1 sourceEnvironment: stage systemEnvironmentId: null status: discovered endpointsCount: 6 discoverySource: api_gateway_app tags: [] discoveredAt: '2026-02-12T04:01:26.000Z' - id: d4e5f6a7-b8c9-0123-defa-234567890123 name: Order - stage (3.0.0) version: 3.0.0 sourceEnvironment: stage systemEnvironmentId: null status: discovered endpointsCount: 2 discoverySource: api_gateway_app tags: [] discoveredAt: '2026-02-12T04:01:26.000Z' - id: b8c9d0e1-f2a3-4567-bcde-678901234567 name: Jelly Bean Wiki (IBM - 9) - sandbox (1.0.0) version: 1.0.0 sourceEnvironment: sandbox systemEnvironmentId: null status: discovered endpointsCount: 3 discoverySource: api_gateway_app tags: [] discoveredAt: '2026-02-12T04:01:26.000Z' - id: c9d0e1f2-a3b4-5678-cdef-789012345678 name: Jelly Bean Wiki (IBM - 8) - sandbox (1.0.0) version: 1.0.0 sourceEnvironment: sandbox systemEnvironmentId: null status: discovered endpointsCount: 3 discoverySource: api_gateway_app tags: [] discoveredAt: '2026-02-12T04:01:26.000Z' - id: d0e1f2a3-b4c5-6789-defa-890123456789 name: Jelly Bean Wiki (IBM - 7) - sandbox (1.0.0) version: 1.0.0 sourceEnvironment: null systemEnvironmentId: null status: discovered endpointsCount: 3 discoverySource: api_gateway_app tags: [] discoveredAt: '2026-02-12T04:01:26.000Z' getApiCatalogDiscoveryServicesFilterBySearch: value: meta: total: 3 nextCursor: null data: - id: 0eab2aa4-d39b-49eb-a17b-d6c7b7eb9c9d name: Order - stage (3.0.0) version: 3.0.0 sourceEnvironment: stage systemEnvironmentId: null status: discovered endpointsCount: 2 discoverySource: api_gateway_app tags: [] discoveredAt: '2026-02-12T04:01:26.000Z' - id: 9014bda4-da6d-45b0-8934-dab552c4b685 name: Order - stage (2.0.0) version: 2.0.0 sourceEnvironment: null systemEnvironmentId: null status: discovered endpointsCount: 2 discoverySource: api_gateway_app tags: [] discoveredAt: '2026-02-12T04:01:26.000Z' - id: 2c254eed-a5d1-4f46-83ca-436d198de8b6 name: Order - sandbox (3.0.0) version: 3.0.0 sourceEnvironment: sandbox systemEnvironmentId: null status: discovered endpointsCount: 2 discoverySource: api_gateway_app tags: [] discoveredAt: '2026-02-12T04:01:26.000Z' getApiCatalogDiscoveryServicesFilterByDiscoverySource: value: meta: total: 2 nextCursor: null data: - id: e191861a-9946-4ec2-bcb4-ef3f1dc62f6d name: ohh/httpbin-deployment-1 version: null sourceEnvironment: null systemEnvironmentId: 99fb6fc1-c9b8-43b4-9857-820bc98eb023 status: integrated endpointsCount: 0 discoverySource: insights_project tags: [] discoveredAt: '2026-03-13T17:41:35.000Z' - id: 1ebbb102-12e9-4c74-8292-1d04fa0fd4cc name: app-namespace-3/httpbin-deployment-3 version: null sourceEnvironment: null systemEnvironmentId: 69fa9fad-692d-49d4-bd3d-6cab5a887ab7 status: integrated endpointsCount: 8 discoverySource: insights_project tags: [] discoveredAt: '2026-02-18T13:15:51.000Z' getApiCatalogDiscoveryServicesResponseWithLimitAndCursor: value: meta: total: 26 nextCursor: eyJpZCI6MjJ9 items: - id: 0eac9b7d-0603-4f16-8a4a-76c78df8fe26 name: Supply - stage (1.0.1) version: 1.0.1 sourceEnvironment: stage systemEnvironmentId: null status: discovered endpointsCount: 6 discoverySource: api_gateway_app tags: [] discoveredAt: '2026-02-12T04:01:26.000Z' - id: 7e83e0d9-66ab-4e1f-a1e7-56c75f5ca95e name: Supply - stage (1.0.0) version: 1.0.0 sourceEnvironment: stage systemEnvironmentId: null status: discovered endpointsCount: 5 discoverySource: api_gateway_app tags: [] discoveredAt: '2026-02-12T04:01:26.000Z' - id: 1478fe99-a3a6-47aa-a6f7-61591f959ce9 name: Supply - sandbox (1.0.0) version: 1.0.0 sourceEnvironment: sandbox systemEnvironmentId: null status: discovered endpointsCount: 6 discoverySource: api_gateway_app tags: [] discoveredAt: '2026-02-12T04:01:26.000Z' getApiCatalogDiscoveryServicesNoResultsFound: value: meta: total: 0 nextCursor: null data: [] getApiCatalogDiscoveryServices400Error: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: 'status values must be one of: discovered, archived, integrated' errors: - path: status message: 'status values must be one of: discovered, archived, integrated' common401ErrorAuthenticationRequired: value: type: https://api.postman.com/problems/unauthorized title: Unauthorized detail: Authentication required status: 401 common403ErrorFeatureDisabled: value: type: https://api.postman.com/problems/forbidden title: Forbidden detail: Feature is disabled. status: 403 postApiCatalogDiscoveryServicesAddService: value: discoveredServices: - name: payment-service postApiCatalogDiscoveryServicesAddFullyPopulatedService: value: discoveredServices: - name: user-service version: 3.0.0 providerServiceId: usr-svc-custom-id-001 description: Handles user registration, authentication, and profile management sourceEnvironment: production endpoints: - method: GET path: /users description: List all users - method: POST path: /users description: Create a new user - method: GET path: /users/{id} description: Get user by ID - method: PUT path: /users/{id} description: Update user - method: DELETE path: /users/{id} description: Delete user tags: - auth - core - identity providerMetadata: commitSha: a1b2c3d4e5f6 branch: main gitRepoUrl: https://github.com/acme/user-service deployedAt: '2026-02-10T12:00:00Z' postApiCatalogDiscoveryServicesAddServiceWithOas: value: discoveredServices: - name: user-service version: 3.0.0 description: Handles user registration, authentication, and profile management. apiDefinition: content: eyJvcGVuYXBpIjoiMy4wLjAiLCJpbmZvIjp7InRpdGxlIjoiQ29uZmlnIiwidmVyc2lvbiI6IjEuMC4wIn0sInBhdGhzIjp7Ii9jb25maWciOnsiZ2V0Ijp7InN1bW1hcnkiOiJHZXQgY29uZmlnIn19LCIvY29uZmlnL3trZXl9Ijp7InB1dCI6eyJzdW1tYXJ5IjoiVXBkYXRlIGNvbmZpZyJ9fX19= postApiCatalogDiscoveryServicesAddMultipleServices: value: discoveredServices: - name: order-service version: 1.0.0 - name: inventory-service version: 2.3.1 - name: notification-service version: 0.9.0 postApiCatalogDiscoveryServicesAddServicesWithSpecsEndpoints: value: discoveredServices: - name: analytics-service version: 1.2.0 description: Tracks usage analytics endpoints: - method: POST path: /events description: Track event - method: GET path: /reports description: Get reports - name: config-service version: 1.0.0 apiDefinition: content: eyJvcGVuYXBpIjoiMy4wLjAiLCJpbmZvIjp7InRpdGxlIjoiQ29uZmlnIiwidmVyc2lvbiI6IjEuMC4wIn0sInBhdGhzIjp7Ii9jb25maWciOnsiZ2V0Ijp7InN1bW1hcnkiOiJHZXQgY29uZmlnIn19LCIvY29uZmlnL3trZXl9Ijp7InB1dCI6eyJzdW1tYXJ5IjoiVXBkYXRlIGNvbmZpZyJ9fX19= - name: healthcheck postApiCatalogDiscoveryServicesAddADiscoveredService: value: data: - id: cad25cdf-e5af-4d15-bd3b-550db1584374 organizationId: 123 name: payment-service description: null version: null sourceEnvironment: null systemEnvironmentId: null tags: [] status: discovered endpointsCount: 0 providerServiceId: payment-service:1.0.0 discoveredAt: '2026-02-12T04:01:26.000Z' discoveredBy: 12345678 lastSyncedAt: '2026-02-12T04:01:26.000Z' meta: total: 1 created: 1 updated: 0 postApiCatalogDiscoveryServicesAddAFullyPopulatedService: value: data: - id: 9feb4e3c-0cd8-44db-b137-7bf09aee73cd organizationId: 123 name: user-service description: Handles user registration, authentication, and profile management. version: 3.0.0 sourceEnvironment: production systemEnvironmentId: null tags: - auth - core - identity status: discovered endpointsCount: 5 providerServiceId: usr-svc-custom-id-001 discoveredAt: '2026-02-12T04:01:26.000Z' discoveredBy: 12345678 lastSyncedAt: '2026-02-12T04:01:26.000Z' meta: total: 1 created: 1 updated: 0 postApiCatalogDiscoveryServicesAddServiceWithAnOpenAPISpecification: value: data: - id: 9feb4e3c-0cd8-44db-b137-7bf09aee73cd organizationId: 123 name: user-service description: Handles user registration, authentication, and profile management. version: 3.0.0 sourceEnvironment: production systemEnvironmentId: null tags: - auth - core - identity status: discovered endpointsCount: 5 providerServiceId: usr-svc-custom-id-001 discoveredAt: '2026-02-12T04:01:26.000Z' discoveredBy: 12345678 lastSyncedAt: '2026-02-12T04:01:26.000Z' meta: total: 1 created: 1 updated: 0 postApiCatalogDiscoveryServicesAddMultipleServicesResponse: value: data: - id: ad800c7e-f304-4731-ba94-ec8e6d61efc6 organizationId: 123 name: order-service description: null version: 1.0.0 sourceEnvironment: null systemEnvironmentId: null tags: [] status: discovered endpointsCount: 0 providerServiceId: order-service:1.0.0 discoveredAt: '2026-02-12T04:01:26.000Z' discoveredBy: 12345678 lastSyncedAt: '2026-02-12T04:01:26.000Z' - id: fb15530b-7166-4777-b167-a3f1a2ce3b68 organizationId: 123 connectionId: 1 name: inventory-service description: null version: 2.3.1 sourceEnvironment: null systemEnvironmentId: null tags: [] status: discovered endpointsCount: 0 providerServiceId: inventory-service:2.3.1 discoveredAt: '2026-02-12T04:01:26.000Z' discoveredBy: 12345678 lastSyncedAt: '2026-02-12T04:01:26.000Z' - id: a4fa1e36-161f-4635-a3f3-db62237b76c2 organizationId: 123 name: notification-service description: null version: 0.9.0 sourceEnvironment: null systemEnvironmentId: null tags: [] status: discovered endpointsCount: 0 providerServiceId: notification-service:0.9.0 discoveredAt: '2026-02-12T04:01:26.000Z' discoveredBy: 12345678 lastSyncedAt: '2026-02-12T04:01:26.000Z' meta: total: 3 created: 3 updated: 0 postApiCatalogDiscoveryServicesAddMultipleServicesWithOpenAPISpecificationsAndEndpoints: value: data: - id: b0c1d2e3-f4a5-6789-bcde-890123456789 organizationId: 123 name: analytics-service description: Tracks usage analytics version: 1.2.0 sourceEnvironment: null systemEnvironmentId: null tags: [] status: discovered endpointsCount: 2 providerServiceId: analytics-service:1.2.0 discoveredAt: '2026-02-12T04:01:26.000Z' discoveredBy: 12345678 lastSyncedAt: '2026-02-12T04:01:26.000Z' - id: b0c1d2e3-f4a5-6789-bcde-890123456781 organizationId: 123 name: config-service description: null version: 1.0.0 sourceEnvironment: null systemEnvironmentId: null tags: [] status: discovered endpointsCount: 2 providerServiceId: config-service:1.0.0 discoveredAt: '2026-02-12T04:01:26.000Z' discoveredBy: 12345678 lastSyncedAt: '2026-02-12T04:01:26.000Z' - id: b0c1d2e3-f4a5-6789-bcde-890123456789 organizationId: 123 name: healthcheck description: null version: null sourceEnvironment: null systemEnvironmentId: null tags: [] status: discovered endpointsCount: 0 providerServiceId: 'healthcheck:' discoveredAt: '2026-02-12T04:01:26.000Z' discoveredBy: 12345678 lastSyncedAt: '2026-02-12T04:01:26.000Z' meta: total: 3 created: 3 updated: 0 postApiCatalogDiscoveryServices400Error: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: 'Validation Error: discoveredServices: Invalid input: expected array, received undefined' errors: - path: discoveredServices message: 'Invalid input: expected array, received undefined' postApiCatalogDiscoveryServices400ErrorPayloadLimitExceeded: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: 'Validation Error: discoveredServices: discoveredServices must not have more than 20 items' errors: - path: discoveredServices message: discoveredServices must not have more than 20 items getApiCatalogDiscoveryServiceSuccessfulResponse: value: id: c6ec74e7-14f8-498c-9470-7a654173bed6 organizationId: 123 discoverySource: api_gateway_app name: Jelly Bean Wiki (IBM - 10) - sandbox (1.0.0) description: null version: 1.0.0 sourceEnvironment: sandbox systemEnvironmentId: null tags: [] status: discovered providerServiceId: 048840c0-1be8-4d9f-a8a6-7429ca50f5ca,989213fc-b1a3-42cb-b0d6-b7843ee5d47d,40d57331-ad73-47a3-87f0-032af447df8e providerMetadata: title: Jelly Bean Wiki (IBM - 10) - sandbox (1.0.0) environmentId: 048840c0-1be8-4d9f-a8a6-7429ca50f5ca,989213fc-b1a3-42cb-b0d6-b7843ee5d47d environmentVersion: 2.0.0 openApiSpecCanBeDownloaded: true apiDefinition: format: openapi_3 formatVersion: 3.0.1 contentHash: 8839a589ba50f454a03f58ec761ad26e2d267a8f26bd63cf6298d4643b23ed7e content: eyJvcGVuYXBpIjoiMy4wLjAiLCJpbmZvIjp7InRpdGxlIjoiQ29uZmlnIiwidmVyc2lvbiI6IjEuMC4wIn0sInBhdGhzIjp7Ii9jb25maWciOnsiZ2V0Ijp7InN1bW1hcnkiOiJHZXQgY29uZmlnIn19LCIvY29uZmlnL3trZXl9Ijp7InB1dCI6eyJzdW1tYXJ5IjoiVXBkYXRlIGNvbmZpZyJ9fX19= endpoints: - method: GET path: /api/recipes description: null - method: GET path: /api/mileStones description: null - method: GET path: /api/Beans description: null endpointsCount: 3 discoveredAt: '2026-02-12T02:04:58.000Z' discoveredBy: 12345678 lastSyncedAt: '2026-02-12T02:04:58.000Z' managedWorkspaceId: null integratedAt: null getApiCatalogServicesSuccessfulResponse: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 timeRange: start: '2026-04-14T12:36:15.339Z' end: '2026-04-21T12:36:15.339Z' label: last_7_days data: - id: a5450abd-ec89-443c-a17a-68132e738714 name: api-control-service status: critical lastActivityAt: '2026-04-21T12:36:00Z' traffic: p95LatencyMs: 251.8122497558594 errorRatePct: 0.78 compliance: monitorRun: status: failed cliRun: status: failed specLint: status: passed createdAt: '2025-12-04T15:13:31.000Z' gitRepo: https://github.com/acs-team/api-control-service owner: type: user id: '12345678' name: Taylor Lee profilePicUrl: https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9 publicHandle: https://www.acs-beta.example.com/orbital-module-specialist-12345678 tags: - develop - acs - beta governanceGroup: id: 4937d932-b1f4-44cd-a929-4a860707766e name: ACS - id: 47d1b387-2485-482a-bf62-46ddd70a6d1e name: API observability status: healthy lastActivityAt: '2026-04-21T07:00:33Z' traffic: p95LatencyMs: 104.64400291442871 errorRatePct: 0 compliance: monitorRun: status: passed cliRun: status: failed specLint: status: failed createdAt: '2024-03-06T20:08:45.000Z' gitRepo: https://github.com/acs-team/observability-service owner: type: user id: '12345678' name: Taylor Lee profilePicUrl: https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9 publicHandle: https://www.acs-beta.example.com/orbital-module-specialist-12345678 tags: [] governanceGroup: null - id: 602af26e-958b-471b-b35a-1d5ff9e8e510 name: identity-service status: inactive lastActivityAt: null traffic: p95LatencyMs: 1175.7943176269537 errorRatePct: 36.8 compliance: monitorRun: status: failed cliRun: status: failed specLint: status: failed createdAt: '2025-12-03T10:46:54.000Z' gitRepo: https://github.com/acs-team/monitor-service owner: type: user id: '12345678' name: Taylor Lee profilePicUrl: https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9 publicHandle: https://www.acs-beta.example.com/orbital-module-specialist-12345678 tags: - develop - acs - beta governanceGroup: id: 4937d932-b1f4-44cd-a929-4a860707766e name: ACS getApiCatalogServicesResponseWithPagination: value: meta: nextCursor: NzI0MTIzOTgsYWktc2VydmljZQ== limit: 2 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 timeRange: start: '2026-04-14T12:36:15.339Z' end: '2026-04-21T12:36:15.339Z' label: last_7_days data: - id: a5450abd-ec89-443c-a17a-68132e738714 name: api-control-service status: critical lastActivityAt: '2026-04-21T12:36:00Z' traffic: p95LatencyMs: 251.8122497558594 errorRatePct: 0.78 compliance: monitorRun: status: failed cliRun: status: failed specLint: status: passed createdAt: '2025-12-04T15:13:31.000Z' gitRepo: https://github.com/acs-team/api-control-service owner: type: user id: '12345678' name: Taylor Lee profilePicUrl: https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9 publicHandle: https://www.acs-beta.example.com/orbital-module-specialist-12345678 tags: - develop - acs - beta governanceGroup: id: 4937d932-b1f4-44cd-a929-4a860707766e name: ACS - id: 47d1b387-2485-482a-bf62-46ddd70a6d1e name: API observability status: healthy lastActivityAt: '2026-04-21T07:00:33Z' traffic: p95LatencyMs: 104.64400291442871 errorRatePct: 0 compliance: monitorRun: status: passed cliRun: status: failed specLint: status: failed createdAt: '2024-03-06T20:08:45.000Z' gitRepo: https://github.com/acs-team/observability-service owner: type: user id: '12345678' name: Taylor Lee profilePicUrl: https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9 publicHandle: https://www.acs-beta.example.com/orbital-module-specialist-12345678 tags: [] governanceGroup: null getApiCatalogServicesFilterByGovernanceGroupId: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 governanceGroupId: 4937d932-b1f4-44cd-a929-4a860707766e timeRange: start: '2026-04-14T12:37:41.101Z' end: '2026-04-21T12:37:41.101Z' label: last_7_days data: - id: a5450abd-ec89-443c-a17a-68132e738714 name: api-control-service status: critical lastActivityAt: '2026-04-21T12:37:27Z' traffic: p95LatencyMs: 251.8122497558594 errorRatePct: 0.78 compliance: monitorRun: status: failed cliRun: status: failed specLint: status: passed createdAt: '2025-12-04T15:13:31.000Z' gitRepo: https://github.com/acs-team/api-control-service owner: type: user id: '12345678' name: Taylor Lee profilePicUrl: https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9 publicHandle: https://www.acs-beta.example.com/orbital-module-specialist-12345678 tags: - develop - acs - beta governanceGroup: id: 4937d932-b1f4-44cd-a929-4a860707766e name: ACS - id: 602af26e-958b-471b-b35a-1d5ff9e8e510 name: identity-service status: inactive lastActivityAt: null traffic: p95LatencyMs: 1175.7943176269537 errorRatePct: 36.8 compliance: monitorRun: status: failed cliRun: status: failed specLint: status: failed createdAt: '2025-12-03T10:46:54.000Z' gitRepo: https://github.com/acs-team/observability-service owner: type: user id: '12345678' name: Taylor Lee profilePicUrl: https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9 publicHandle: https://www.acs-beta.example.com/orbital-module-specialist-12345678 tags: - develop - acs - beta governanceGroup: id: 4937d932-b1f4-44cd-a929-4a860707766e name: ACS getApiCatalogServicesFilterByTags: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 tags: - acs timeRange: start: '2026-04-14T12:37:00.566Z' end: '2026-04-21T12:37:00.566Z' label: last_7_days data: - id: a5450abd-ec89-443c-a17a-68132e738714 name: api-control-service status: critical lastActivityAt: '2026-04-21T12:36:58Z' traffic: p95LatencyMs: 251.8122497558594 errorRatePct: 0.78 compliance: monitorRun: status: failed cliRun: status: failed specLint: status: passed createdAt: '2025-12-04T15:13:31.000Z' gitRepo: https://github.com/acs-team/api-control-service owner: type: user id: '12345678' name: Taylor Lee profilePicUrl: https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9 publicHandle: https://www.acs-beta.example.com/orbital-module-specialist-12345678 tags: - develop - acs - beta governanceGroup: id: 4937d932-b1f4-44cd-a929-4a860707766e name: ACS - id: 602af26e-958b-471b-b35a-1d5ff9e8e510 name: observability-service status: inactive lastActivityAt: null traffic: p95LatencyMs: 1175.7943176269537 errorRatePct: 36.8 compliance: monitorRun: status: failed cliRun: status: failed specLint: status: failed createdAt: '2025-12-03T10:46:54.000Z' gitRepo: https://github.com/acs-team/observability-service owner: type: user id: '12345678' name: Taylor Lee profilePicUrl: https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9 publicHandle: https://www.acs-beta.example.com/orbital-module-specialist-12345678 tags: - develop - acs - beta governanceGroup: id: 4937d932-b1f4-44cd-a929-4a860707766e name: ACS getApiCatalogServicesFilterByName: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 name: acs timeRange: start: '2026-04-14T12:27:36.779Z' end: '2026-04-21T12:27:36.779Z' label: last_7_days data: - id: a5450abd-ec89-443c-a17a-68132e738714 name: api-control-service status: critical lastActivityAt: '2026-04-21T12:27:32Z' traffic: p95LatencyMs: 251.8122497558594 errorRatePct: 0.78 compliance: monitorRun: status: failed cliRun: status: failed specLint: status: passed createdAt: '2025-12-04T15:13:31.000Z' gitRepo: https://github.com/postman-eng/api-control-service owner: type: user id: '12345678' name: Taylor Lee profilePicUrl: https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9 publicHandle: https://www.acs-beta.example.com/orbital-module-specialist-12345678 tags: - develop - acs - beta governanceGroup: id: 4937d932-b1f4-44cd-a929-4a860707766e name: ACS apiCatalogService400ErrorSystemEnvironmentIdInvalid: value: type: https://api.postman.com/problems/bad-request title: Bad Request detail: 'Validation Error: systemEnvironmentId: Invalid input: expected string, received undefined' status: 400 errors: - path: systemEnvironmentId message: 'Invalid input: expected string, received undefined' apiCatalogService400ErrorOptionInvalid: value: type: https://api.postman.com/problems/bad-request title: Bad Request detail: 'Validation Error: status: Invalid option: expected one of "passed"|"failed"' status: 400 errors: - path: status message: 'Invalid option: expected one of "passed"|"failed"' getApiCatalogServiceSuccessfulResponse: value: meta: filters: {} timeRange: start: '2026-04-14T13:09:36.521Z' end: '2026-04-21T13:09:36.521Z' label: last_7_days data: id: a5450abd-ec89-443c-a17a-68132e738714 name: api-control-service status: critical lastActivityAt: '2026-04-21T13:09:33Z' traffic: p95LatencyMs: 251.8122497558594 errorRatePct: 0.78 totalRequests: 10999 totalRequestsDeltaPct: 398.82 totalErrors: 86 totalEndpoints: 10 p95LatencyMsDeltaPct: 0.47 errorRatePctDeltaPct: 188.89 compliance: monitorRun: status: failed totalMonitors: 3 activeMonitors: 3 passingMonitors: 1 failingMonitors: 2 lastRunAt: '2026-04-21T13:09:24.847Z' cliRun: status: failed activePipelines: 5 passingPipelines: 3 failingPipelines: 2 lastRunAt: '2026-04-19T12:08:43.112Z' specLint: status: passed totalSpecs: 2 activeSpecs: 1 passingSpecs: 1 failingSpecs: 0 lastRunAt: '2026-04-19T12:08:43.110Z' collectionRuns: totalRuns: 3159 passedRuns: 462 failedRuns: 2697 passRate: 14.62 totalCollections: 2 activeCollections: 2 totalAssertions: 161456 failedAssertions: 69355 entityCounts: collections: 2 specifications: 2 monitors: 3 mocks: 0 flows: 0 environments: 2 createdAt: '2025-12-04T15:13:31.000Z' gitRepo: https://github.com/acs-team/api-control-service owner: type: user id: '12345678' name: Taylor Lee profilePicUrl: https://res.cloudinary.com/ddn1d7iih/image/upload/t_user_profile_300/v1/user/default-9 publicHandle: https://www.acs-beta.example.com/orbital-module-specialist-12345678 tags: - acs-beta - acs governanceGroup: id: 4937d932-b1f4-44cd-a929-4a860707766e name: ACS dependencies: - id: svc_3l2QDWTQQ161UYpSwGK34U name: external direction: inbound - id: svc_5izBBtWeFwxRhvtqJwfNU7 name: Identity - Beta direction: inbound - id: svc_5izBBtWeFwxRhvtqJwfNU7 name: Identity - Beta direction: outbound apiCatalogService404ErrorServiceNotFound: value: type: https://api.postman.com/problems/not-found status: 404 title: Not Found detail: Service not found. getApiCatalogServiceEndpointsSuccessfulResponse: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 timeRange: start: '2026-04-14T13:10:07.480Z' end: '2026-04-21T13:10:07.480Z' label: last_7_days totalEndpoints: 11 totalRequests: 16022 data: - method: PATCH path: /api/v1/object-groups/{group} host: acs-test-new.example.com requestCount: 2916 performance: p90LatencyMs: 19.701 p95LatencyMs: 21.59825 errors: totalErrors: 16 errorRatePct: 0.55 breakdown: '400': 8 '500': 8 - method: DELETE path: /api/v1/object-groups/{group} host: acs-test-new.example.com requestCount: 2866 performance: p90LatencyMs: 30.4165 p95LatencyMs: 33.5495 errors: totalErrors: 6 errorRatePct: 0.21 breakdown: '400': 6 - method: POST path: /api/v1/object-groups host: acs-test-new.example.com requestCount: 2774 performance: p90LatencyMs: 20.300701 p95LatencyMs: 22.9377 errors: totalErrors: 20 errorRatePct: 0.72 breakdown: '401': 12 '500': 8 - method: POST path: /api/permissions/check host: acs-test-new.example.com requestCount: 2063 performance: p90LatencyMs: 295.8238 p95LatencyMs: 321.0344 errors: totalErrors: 8 errorRatePct: 0.39 breakdown: '400': 6 '500': 2 - method: POST path: /api/v2/groups host: acs-test-new.example.com requestCount: 1979 performance: p90LatencyMs: 21.105799 p95LatencyMs: 23.576601 errors: totalErrors: 2 errorRatePct: 0.1 breakdown: '401': 2 - method: POST path: /api/groups/delete host: acs-test-new.example.com requestCount: 1033 performance: p90LatencyMs: 43.736202 p95LatencyMs: 48.807 errors: totalErrors: 2 errorRatePct: 0.19 breakdown: '401': 2 - method: POST path: /api/roles/add host: acs-test-new.example.com requestCount: 1031 performance: p90LatencyMs: 20.06 p95LatencyMs: 22.2735 errors: totalErrors: 4 errorRatePct: 0.39 breakdown: '401': 4 - method: POST path: /api/permissions/list/by-objects host: acs-test-new.example.com requestCount: 928 performance: p90LatencyMs: 193.14041 p95LatencyMs: 219.2336 errors: totalErrors: 2 errorRatePct: 0.22 breakdown: '401': 2 - method: GET path: /api/v1/role-assignments host: acs-test-new.example.com requestCount: 382 performance: p90LatencyMs: 12.8354 p95LatencyMs: 15.002851 errors: totalErrors: 96 errorRatePct: 25.13 breakdown: '400': 96 - method: POST path: /api/roles/remove host: acs-test-new.example.com requestCount: 48 performance: p90LatencyMs: 32.1342 p95LatencyMs: 34.145298 errors: totalErrors: 0 errorRatePct: 0 breakdown: {} - method: GET path: /api/permissions/MANAGE_SYSTEM_ENVIRONMENT host: acs-test-new.example.com requestCount: 2 performance: p90LatencyMs: 11.3602 p95LatencyMs: 11.3716 errors: totalErrors: 0 errorRatePct: 0 breakdown: {} getApiCatalogServiceEndpointsResponseWithPagination: value: meta: nextCursor: NzI0MTIzOTgsYWktc2VydmljZQ== limit: 5 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 timeRange: start: '2026-04-14T13:11:18.161Z' end: '2026-04-21T13:11:18.161Z' label: last_7_days totalEndpoints: 11 totalRequests: 16022 data: - method: DELETE path: /api/groups/delete host: acs-test-new.example.com requestCount: 1033 performance: p90LatencyMs: 43.736202 p95LatencyMs: 48.807 errors: totalErrors: 2 errorRatePct: 0.19 breakdown: '401': 2 - method: POST path: /api/roles/add host: acs-test-new.example.com requestCount: 1031 performance: p90LatencyMs: 20.06 p95LatencyMs: 22.2735 errors: totalErrors: 4 errorRatePct: 0.39 breakdown: '401': 4 - method: GET path: /api/permissions/list/by-objects host: acs-test-new.example.com requestCount: 928 performance: p90LatencyMs: 193.14041 p95LatencyMs: 219.2336 errors: totalErrors: 2 errorRatePct: 0.22 breakdown: '401': 2 - method: GET path: /api/v1/role-assignments host: acs-test-new.example.com requestCount: 382 performance: p90LatencyMs: 12.8354 p95LatencyMs: 15.002851 errors: totalErrors: 96 errorRatePct: 25.13 breakdown: '400': 96 - method: POST path: /api/roles/remove host: acs-test-new.example.com requestCount: 48 performance: p90LatencyMs: 32.1342 p95LatencyMs: 34.145298 errors: totalErrors: 0 errorRatePct: 0 breakdown: {} getApiCatalogServiceEndpointsSortResultsByErrorRate: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 sort: error_rate:desc timeRange: start: '2026-04-14T13:15:42.407Z' end: '2026-04-21T13:15:42.407Z' label: last_7_days totalEndpoints: 11 totalRequests: 16022 data: - method: GET path: /api/v1/role-assignments host: acs-test-new.example.com requestCount: 382 performance: p90LatencyMs: 12.8354 p95LatencyMs: 15.002851 errors: totalErrors: 96 errorRatePct: 25.13 breakdown: '400': 96 - method: POST path: /api/v1/object-groups host: acs-test-new.example.com requestCount: 2774 performance: p90LatencyMs: 20.300701 p95LatencyMs: 22.9377 errors: totalErrors: 20 errorRatePct: 0.72 breakdown: '401': 12 '500': 8 - method: PATCH path: /api/v1/object-groups/{group} host: acs-test-new.example.com requestCount: 2916 performance: p90LatencyMs: 19.701 p95LatencyMs: 21.59825 errors: totalErrors: 16 errorRatePct: 0.55 breakdown: '400': 8 '500': 8 - method: POST path: /api/roles/add host: acs-test-new.example.com requestCount: 1031 performance: p90LatencyMs: 20.06 p95LatencyMs: 22.2735 errors: totalErrors: 4 errorRatePct: 0.39 breakdown: '401': 4 - method: POST path: /api/permissions/check host: acs-test-new.example.com requestCount: 2063 performance: p90LatencyMs: 295.8238 p95LatencyMs: 321.0344 errors: totalErrors: 8 errorRatePct: 0.39 breakdown: '400': 6 '500': 2 - method: POST path: /api/permissions/list/by-objects host: acs-test-new.example.com requestCount: 928 performance: p90LatencyMs: 193.14041 p95LatencyMs: 219.2336 errors: totalErrors: 2 errorRatePct: 0.22 breakdown: '401': 2 - method: DELETE path: /api/v1/object-groups/{group} host: acs-test-new.example.com requestCount: 2866 performance: p90LatencyMs: 30.4165 p95LatencyMs: 33.5495 errors: totalErrors: 6 errorRatePct: 0.21 breakdown: '400': 6 - method: DELETE path: /api/groups/delete host: acs-test-new.example.com requestCount: 1033 performance: p90LatencyMs: 43.736202 p95LatencyMs: 48.807 errors: totalErrors: 2 errorRatePct: 0.19 breakdown: '401': 2 - method: POST path: /api/v2/groups host: acs-test-new.example.com requestCount: 1979 performance: p90LatencyMs: 21.105799 p95LatencyMs: 23.576601 errors: totalErrors: 2 errorRatePct: 0.1 breakdown: '401': 2 - method: GET path: /api/permissions/MANAGE_SYSTEM_ENVIRONMENT host: acs-test-new.example.com requestCount: 2 performance: p90LatencyMs: 11.3602 p95LatencyMs: 11.3716 errors: totalErrors: 0 errorRatePct: 0 breakdown: {} - method: POST path: /api/roles/remove host: acs-test-new.example.com requestCount: 48 performance: p90LatencyMs: 32.1342 p95LatencyMs: 34.145298 errors: totalErrors: 0 errorRatePct: 0 breakdown: {} getApiCatalogServiceEndpointsFilterByResponseCodes: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 responseCodes: - 400 - 500 timeRange: start: '2026-04-14T13:14:00.159Z' end: '2026-04-21T13:14:00.159Z' label: last_7_days totalEndpoints: 5 totalRequests: 134 data: - method: GET path: /api/v1/role-assignments host: acs-test-new.example.com requestCount: 96 performance: p90LatencyMs: 8.4765 p95LatencyMs: 8.83725 errors: totalErrors: 96 errorRatePct: 100 breakdown: '400': 96 - method: PATCH path: /api/v1/object-groups/{group} host: acs-test-new.example.com requestCount: 16 performance: p90LatencyMs: 50826.41 p95LatencyMs: 50891.562 errors: totalErrors: 16 errorRatePct: 100 breakdown: '400': 8 '500': 8 - method: POST path: /api/permissions/check host: acs-test-new.example.com requestCount: 8 performance: p90LatencyMs: 5220.585 p95LatencyMs: 5220.6978 errors: totalErrors: 8 errorRatePct: 100 breakdown: '400': 6 '500': 2 - method: POST path: /api/v1/object-groups host: acs-test-new.example.com requestCount: 8 performance: p90LatencyMs: 51214.426 p95LatencyMs: 51214.535 errors: totalErrors: 8 errorRatePct: 100 breakdown: '500': 8 - method: DELETE path: /api/v1/object-groups/{group} host: acs-test-new.example.com requestCount: 6 performance: p90LatencyMs: 12.9855 p95LatencyMs: 13.06725 errors: totalErrors: 6 errorRatePct: 100 breakdown: '400': 6 getApiCatalogServiceEndpointsFilterBySearch: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 search: object-group timeRange: start: '2026-04-14T13:14:47.841Z' end: '2026-04-21T13:14:47.841Z' label: last_7_days totalEndpoints: 3 totalRequests: 8556 data: - method: PATCH path: /api/v1/object-groups/{group} host: acs-test-new.example.com requestCount: 2916 performance: p90LatencyMs: 19.701 p95LatencyMs: 21.59825 errors: totalErrors: 16 errorRatePct: 0.55 breakdown: '400': 8 '500': 8 - method: DELETE path: /api/v1/object-groups/{group} host: acs-test-new.example.com requestCount: 2866 performance: p90LatencyMs: 30.4165 p95LatencyMs: 33.5495 errors: totalErrors: 6 errorRatePct: 0.21 breakdown: '400': 6 - method: POST path: /api/v1/object-groups host: acs-test-new.example.com requestCount: 2774 performance: p90LatencyMs: 20.300701 p95LatencyMs: 22.9377 errors: totalErrors: 20 errorRatePct: 0.72 breakdown: '401': 12 '500': 8 getApiCatalogServiceEndpointsFilterByHosts: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 hosts: - acs-test-new.example.com timeRange: start: '2026-04-14T13:12:35.312Z' end: '2026-04-21T13:12:35.312Z' label: last_7_days totalEndpoints: 11 totalRequests: 16022 data: - method: PATCH path: /api/v1/object-groups/{group} host: acs-test-new.example.com requestCount: 2916 performance: p90LatencyMs: 19.701 p95LatencyMs: 21.59825 errors: totalErrors: 16 errorRatePct: 0.55 breakdown: '400': 8 '500': 8 - method: DELETE path: /api/v1/object-groups/{group} host: acs-test-new.example.com requestCount: 2866 performance: p90LatencyMs: 30.4165 p95LatencyMs: 33.5495 errors: totalErrors: 6 errorRatePct: 0.21 breakdown: '400': 6 - method: POST path: /api/v1/object-groups host: acs-test-new.example.com requestCount: 2774 performance: p90LatencyMs: 20.300701 p95LatencyMs: 22.9377 errors: totalErrors: 20 errorRatePct: 0.72 breakdown: '401': 12 '500': 8 - method: POST path: /api/permissions/check host: acs-test-new.example.com requestCount: 2063 performance: p90LatencyMs: 295.8238 p95LatencyMs: 321.0344 errors: totalErrors: 8 errorRatePct: 0.39 breakdown: '400': 6 '500': 2 - method: POST path: /api/v2/groups host: acs-test-new.example.com requestCount: 1979 performance: p90LatencyMs: 21.105799 p95LatencyMs: 23.576601 errors: totalErrors: 2 errorRatePct: 0.1 breakdown: '401': 2 - method: POST path: /api/groups/delete host: acs-test-new.example.com requestCount: 1033 performance: p90LatencyMs: 43.736202 p95LatencyMs: 48.807 errors: totalErrors: 2 errorRatePct: 0.19 breakdown: '401': 2 - method: POST path: /api/roles/add host: acs-test-new.example.com requestCount: 1031 performance: p90LatencyMs: 20.06 p95LatencyMs: 22.2735 errors: totalErrors: 4 errorRatePct: 0.39 breakdown: '401': 4 - method: POST path: /api/permissions/list/by-objects host: acs-test-new.example.com requestCount: 928 performance: p90LatencyMs: 193.14041 p95LatencyMs: 219.2336 errors: totalErrors: 2 errorRatePct: 0.22 breakdown: '401': 2 - method: GET path: /api/v1/role-assignments host: acs-test-new.example.com requestCount: 382 performance: p90LatencyMs: 12.8354 p95LatencyMs: 15.002851 errors: totalErrors: 96 errorRatePct: 25.13 breakdown: '400': 96 - method: POST path: /api/roles/remove host: acs-test-new.example.com requestCount: 48 performance: p90LatencyMs: 32.1342 p95LatencyMs: 34.145298 errors: totalErrors: 0 errorRatePct: 0 breakdown: {} - method: GET path: /api/permissions/MANAGE_SYSTEM_ENVIRONMENT host: acs-test-new.example.com requestCount: 2 performance: p90LatencyMs: 11.3602 p95LatencyMs: 11.3716 errors: totalErrors: 0 errorRatePct: 0 breakdown: {} getApiCatalogServiceEndpointsFilterByHttpMethods: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 httpMethods: - DELETE - PATCH timeRange: start: '2026-04-14T13:11:58.975Z' end: '2026-04-21T13:11:58.975Z' label: last_7_days totalEndpoints: 2 totalRequests: 5782 data: - method: PATCH path: /api/v1/object-groups/{group} host: acs-test-new.example.com requestCount: 2916 performance: p90LatencyMs: 19.701 p95LatencyMs: 21.59825 errors: totalErrors: 16 errorRatePct: 0.55 breakdown: '400': 8 '500': 8 - method: DELETE path: /api/v1/object-groups/{group} host: acs-test-new.example.com requestCount: 2866 performance: p90LatencyMs: 30.4165 p95LatencyMs: 33.5495 errors: totalErrors: 6 errorRatePct: 0.21 breakdown: '400': 6 getApiCatalogServiceMonitorRunsSuccessfulResponse: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 timeRange: start: '2026-04-14T13:19:51.736Z' end: '2026-04-21T13:19:51.736Z' label: last_7_days totalRuns: 1034 passedRuns: 456 failedRuns: 578 successRatePct: 44.1 data: - id: 019d9ef1-4441-7d5d-892b-cf280e19c12d status: passed timestamp: '2026-04-18T04:55:04.898Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1747 performance: minResponseMs: 17 maxResponseMs: 308 - id: 019d9eec-b572-7ea0-a76f-be24a3fa9e65 status: failed timestamp: '2026-04-18T04:50:06.226Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1666 performance: minResponseMs: 20 maxResponseMs: 279 - id: 019d9ee8-2d69-70ce-aee3-4d45a01dda3b status: failed timestamp: '2026-04-18T04:45:09.245Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1506 performance: minResponseMs: 16 maxResponseMs: 250 - id: 019d9ee3-a669-7e8c-8bb3-f10e7e557081 status: failed timestamp: '2026-04-18T04:40:12.552Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1815 performance: minResponseMs: 16 maxResponseMs: 355 - id: 019d9edf-039c-73d5-ab3d-38c4dbacb5c9 status: passed timestamp: '2026-04-18T04:35:08.737Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1607 performance: minResponseMs: 18 maxResponseMs: 325 - id: 019d9eda-7278-7f26-869d-c140559c4114 status: passed timestamp: '2026-04-18T04:30:09.422Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1404 performance: minResponseMs: 17 maxResponseMs: 240 - id: 019d9ed5-ecc8-72b7-bff8-52f74e7643cb status: passed timestamp: '2026-04-18T04:25:13.026Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1696 performance: minResponseMs: 17 maxResponseMs: 281 - id: 019d9ed1-5a43-7e05-a076-ea4478cba9f8 status: passed timestamp: '2026-04-18T04:20:13.390Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1799 performance: minResponseMs: 19 maxResponseMs: 304 - id: 019d9ecc-a81a-7999-8044-6052538df819 status: failed timestamp: '2026-04-18T04:15:05.635Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1420 performance: minResponseMs: 19 maxResponseMs: 231 - id: 019d9ec8-10bb-7033-ac29-5e8cc9e254b2 status: failed timestamp: '2026-04-18T04:10:04.743Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1512 performance: minResponseMs: 17 maxResponseMs: 285 - id: 019d9ec3-9a04-7722-8732-43ff3eba4ede status: failed timestamp: '2026-04-18T04:05:12.214Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1661 performance: minResponseMs: 19 maxResponseMs: 256 - id: 019d9ebf-2052-7f7c-9e09-e9fcde166030 status: failed timestamp: '2026-04-18T04:00:18.914Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1699 performance: minResponseMs: 16 maxResponseMs: 321 - id: 019d9eba-67b8-78b6-83e1-803f8b60bae5 status: failed timestamp: '2026-04-18T03:55:09.525Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1454 performance: minResponseMs: 16 maxResponseMs: 233 - id: 019d9eb5-cea5-7c95-875b-c9bcb87c7cf3 status: passed timestamp: '2026-04-18T03:50:08.215Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 2052 performance: minResponseMs: 17 maxResponseMs: 421 - id: 019d9eb1-4546-766b-bfdd-0bf0667c2daa status: failed timestamp: '2026-04-18T03:45:10.866Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1641 performance: minResponseMs: 17 maxResponseMs: 231 - id: 019d9eac-9d81-775f-9a93-f1363b151960 status: passed timestamp: '2026-04-18T03:40:05.781Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1671 performance: minResponseMs: 19 maxResponseMs: 299 - id: 019d9ea8-1eea-76da-be6d-1bbef4e1d596 status: failed timestamp: '2026-04-18T03:35:11.231Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1476 performance: minResponseMs: 18 maxResponseMs: 251 - id: 019d9ea3-b5fa-77c2-a31f-e95ec3c2f83a status: failed timestamp: '2026-04-18T03:30:22.230Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1444 performance: minResponseMs: 18 maxResponseMs: 256 - id: 019d9e9e-ef46-791b-be86-0396ffc86829 status: failed timestamp: '2026-04-18T03:25:09.181Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1667 performance: minResponseMs: 16 maxResponseMs: 261 - id: 019d9e9a-4e68-7aff-99ef-b813644df20f status: passed timestamp: '2026-04-18T03:20:05.884Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1782 performance: minResponseMs: 20 maxResponseMs: 332 getApiCatalogServiceMonitorRunsResponseWithPagination: value: meta: nextCursor: NzI0MTIzOTgsYWktc2VydmljZQ== limit: 10 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 timeRange: start: '2026-04-14T13:35:05.333Z' end: '2026-04-21T13:35:05.333Z' label: last_7_days totalRuns: 1026 passedRuns: 454 failedRuns: 572 successRatePct: 44.25 data: - id: 019d9ec3-9a04-7722-8732-43ff3eba4ede status: failed timestamp: '2026-04-18T04:05:12.214Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1661 performance: minResponseMs: 19 maxResponseMs: 256 - id: 019d9ebf-2052-7f7c-9e09-e9fcde166030 status: failed timestamp: '2026-04-18T04:00:18.914Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1699 performance: minResponseMs: 16 maxResponseMs: 321 - id: 019d9eba-67b8-78b6-83e1-803f8b60bae5 status: failed timestamp: '2026-04-18T03:55:09.525Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1454 performance: minResponseMs: 16 maxResponseMs: 233 - id: 019d9eb5-cea5-7c95-875b-c9bcb87c7cf3 status: passed timestamp: '2026-04-18T03:50:08.215Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 2052 performance: minResponseMs: 17 maxResponseMs: 421 - id: 019d9eb1-4546-766b-bfdd-0bf0667c2daa status: failed timestamp: '2026-04-18T03:45:10.866Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1641 performance: minResponseMs: 17 maxResponseMs: 231 - id: 019d9eac-9d81-775f-9a93-f1363b151960 status: passed timestamp: '2026-04-18T03:40:05.781Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1671 performance: minResponseMs: 19 maxResponseMs: 299 - id: 019d9ea8-1eea-76da-be6d-1bbef4e1d596 status: failed timestamp: '2026-04-18T03:35:11.231Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1476 performance: minResponseMs: 18 maxResponseMs: 251 - id: 019d9ea3-b5fa-77c2-a31f-e95ec3c2f83a status: failed timestamp: '2026-04-18T03:30:22.230Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1444 performance: minResponseMs: 18 maxResponseMs: 256 - id: 019d9e9e-ef46-791b-be86-0396ffc86829 status: failed timestamp: '2026-04-18T03:25:09.181Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1667 performance: minResponseMs: 16 maxResponseMs: 261 - id: 019d9e9a-4e68-7aff-99ef-b813644df20f status: passed timestamp: '2026-04-18T03:20:05.884Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1782 performance: minResponseMs: 20 maxResponseMs: 332 getApiCatalogServiceMonitorRunsFilterWithSort: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 sort: failedAssertions:desc timeRange: start: '2026-04-14T13:35:51.155Z' end: '2026-04-21T13:35:51.155Z' label: last_7_days totalRuns: 1026 passedRuns: 454 failedRuns: 572 successRatePct: 44.25 data: - id: 019d9b72-5f4b-75f7-a5d4-adea60a2f0e0 status: failed timestamp: '2026-04-17T12:37:37.087Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 19 durationMs: 153791 performance: minResponseMs: 9 maxResponseMs: 51233 - id: 019d9b76-ed98-7444-8a4e-ae416ab94314 status: failed timestamp: '2026-04-17T12:42:35.680Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 19 durationMs: 152575 performance: minResponseMs: 8 maxResponseMs: 50570 - id: 019d9b69-4466-753e-b17e-73fbcbf6927b status: failed timestamp: '2026-04-17T12:27:40.416Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 7 durationMs: 152340 performance: minResponseMs: 20 maxResponseMs: 50657 - id: 019d9b6d-cc04-741d-8dd1-50d21e9f90cc status: failed timestamp: '2026-04-17T12:32:37.277Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 7 durationMs: 154992 performance: minResponseMs: 27 maxResponseMs: 50907 - id: 019d9717-c7d5-78a0-a9ac-aec9384a4c31 status: failed timestamp: '2026-04-16T16:20:11.234Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 4 durationMs: 6722 performance: minResponseMs: 18 maxResponseMs: 5230 - id: 019d9eb1-4546-766b-bfdd-0bf0667c2daa status: failed timestamp: '2026-04-18T03:45:10.866Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1641 performance: minResponseMs: 17 maxResponseMs: 231 - id: 019d96d7-aa3c-7e47-bfcf-af30d18c4961 status: failed timestamp: '2026-04-16T15:10:09.349Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1687 performance: minResponseMs: 19 maxResponseMs: 223 - id: 019d9a6b-2c00-72e5-bfa6-274bd50ecc94 status: failed timestamp: '2026-04-17T07:50:08.030Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1536 performance: minResponseMs: 19 maxResponseMs: 333 - id: 019d9dec-68e4-7906-bf5a-5f8e59448ec6 status: failed timestamp: '2026-04-18T00:10:09.396Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1717 performance: minResponseMs: 17 maxResponseMs: 252 - id: e5260e74-17e1-4920-bf26-3b0b8fd116f7 status: failed timestamp: '2026-04-15T10:00:13.925Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1355 performance: minResponseMs: 17 maxResponseMs: 235 - id: 2d680c48-3533-4792-bf1d-f2187b228b6d status: failed timestamp: '2026-04-15T09:30:26.296Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1538 performance: minResponseMs: 19 maxResponseMs: 295 - id: 019d992a-d15d-7e72-beff-4677252e061e status: failed timestamp: '2026-04-17T02:00:13.296Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1427 performance: minResponseMs: 18 maxResponseMs: 220 - id: 12884123-e531-4fe5-beee-599b3dd2a7ff status: failed timestamp: '2026-04-14T23:00:05.836Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1685 performance: minResponseMs: 21 maxResponseMs: 258 - id: 019d9e9e-ef46-791b-be86-0396ffc86829 status: failed timestamp: '2026-04-18T03:25:09.181Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1667 performance: minResponseMs: 16 maxResponseMs: 261 - id: 2c5d738b-3051-40c8-be84-b09075544c8b status: failed timestamp: '2026-04-15T10:55:04.889Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1644 performance: minResponseMs: 15 maxResponseMs: 243 - id: 019d9ea8-1eea-76da-be6d-1bbef4e1d596 status: failed timestamp: '2026-04-18T03:35:11.231Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1476 performance: minResponseMs: 18 maxResponseMs: 251 - id: 019d9672-e707-73d0-be50-171ff21568b3 status: failed timestamp: '2026-04-16T13:20:05.763Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1680 performance: minResponseMs: 18 maxResponseMs: 257 - id: 019d9c75-05c7-7058-be4b-ab6fc4788380 status: failed timestamp: '2026-04-17T17:20:07.967Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1793 performance: minResponseMs: 22 maxResponseMs: 257 - id: 019d9a34-319a-7690-bdee-d3479369efde status: failed timestamp: '2026-04-17T06:50:04.957Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1785 performance: minResponseMs: 17 maxResponseMs: 305 - id: 019d9881-508a-77cd-bdea-4d8d0a10f156 status: failed timestamp: '2026-04-16T22:55:04.729Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1588 performance: minResponseMs: 19 maxResponseMs: 298 getApiCatalogServiceMonitorRunsFilterByEnvironmentId: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 environmentId: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 timeRange: start: '2026-04-14T13:36:43.850Z' end: '2026-04-21T13:36:43.850Z' label: last_7_days totalRuns: 1026 passedRuns: 454 failedRuns: 572 successRatePct: 44.25 data: - id: 019d9ef1-4441-7d5d-892b-cf280e19c12d status: passed timestamp: '2026-04-18T04:55:04.898Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1747 performance: minResponseMs: 17 maxResponseMs: 308 - id: 019d9eec-b572-7ea0-a76f-be24a3fa9e65 status: failed timestamp: '2026-04-18T04:50:06.226Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1666 performance: minResponseMs: 20 maxResponseMs: 279 - id: 019d9ee8-2d69-70ce-aee3-4d45a01dda3b status: failed timestamp: '2026-04-18T04:45:09.245Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1506 performance: minResponseMs: 16 maxResponseMs: 250 - id: 019d9ee3-a669-7e8c-8bb3-f10e7e557081 status: failed timestamp: '2026-04-18T04:40:12.552Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1815 performance: minResponseMs: 16 maxResponseMs: 355 - id: 019d9edf-039c-73d5-ab3d-38c4dbacb5c9 status: passed timestamp: '2026-04-18T04:35:08.737Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1607 performance: minResponseMs: 18 maxResponseMs: 325 - id: 019d9eda-7278-7f26-869d-c140559c4114 status: passed timestamp: '2026-04-18T04:30:09.422Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1404 performance: minResponseMs: 17 maxResponseMs: 240 - id: 019d9ed5-ecc8-72b7-bff8-52f74e7643cb status: passed timestamp: '2026-04-18T04:25:13.026Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1696 performance: minResponseMs: 17 maxResponseMs: 281 - id: 019d9ed1-5a43-7e05-a076-ea4478cba9f8 status: passed timestamp: '2026-04-18T04:20:13.390Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1799 performance: minResponseMs: 19 maxResponseMs: 304 - id: 019d9ecc-a81a-7999-8044-6052538df819 status: failed timestamp: '2026-04-18T04:15:05.635Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1420 performance: minResponseMs: 19 maxResponseMs: 231 - id: 019d9ec8-10bb-7033-ac29-5e8cc9e254b2 status: failed timestamp: '2026-04-18T04:10:04.743Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1512 performance: minResponseMs: 17 maxResponseMs: 285 - id: 019d9ec3-9a04-7722-8732-43ff3eba4ede status: failed timestamp: '2026-04-18T04:05:12.214Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1661 performance: minResponseMs: 19 maxResponseMs: 256 - id: 019d9ebf-2052-7f7c-9e09-e9fcde166030 status: failed timestamp: '2026-04-18T04:00:18.914Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1699 performance: minResponseMs: 16 maxResponseMs: 321 - id: 019d9eba-67b8-78b6-83e1-803f8b60bae5 status: failed timestamp: '2026-04-18T03:55:09.525Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1454 performance: minResponseMs: 16 maxResponseMs: 233 - id: 019d9eb5-cea5-7c95-875b-c9bcb87c7cf3 status: passed timestamp: '2026-04-18T03:50:08.215Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 2052 performance: minResponseMs: 17 maxResponseMs: 421 - id: 019d9eb1-4546-766b-bfdd-0bf0667c2daa status: failed timestamp: '2026-04-18T03:45:10.866Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1641 performance: minResponseMs: 17 maxResponseMs: 231 - id: 019d9eac-9d81-775f-9a93-f1363b151960 status: passed timestamp: '2026-04-18T03:40:05.781Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1671 performance: minResponseMs: 19 maxResponseMs: 299 - id: 019d9ea8-1eea-76da-be6d-1bbef4e1d596 status: failed timestamp: '2026-04-18T03:35:11.231Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1476 performance: minResponseMs: 18 maxResponseMs: 251 - id: 019d9ea3-b5fa-77c2-a31f-e95ec3c2f83a status: failed timestamp: '2026-04-18T03:30:22.230Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1444 performance: minResponseMs: 18 maxResponseMs: 256 - id: 019d9e9e-ef46-791b-be86-0396ffc86829 status: failed timestamp: '2026-04-18T03:25:09.181Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1667 performance: minResponseMs: 16 maxResponseMs: 261 - id: 019d9e9a-4e68-7aff-99ef-b813644df20f status: passed timestamp: '2026-04-18T03:20:05.884Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1782 performance: minResponseMs: 20 maxResponseMs: 332 getApiCatalogServiceMonitorRunsFilterByStatus: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 status: failed timeRange: start: '2026-04-14T13:29:41.361Z' end: '2026-04-21T13:29:41.361Z' label: last_7_days totalRuns: 574 passedRuns: 0 failedRuns: 574 successRatePct: 0 data: - id: 019d9eec-b572-7ea0-a76f-be24a3fa9e65 status: failed timestamp: '2026-04-18T04:50:06.226Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1666 performance: minResponseMs: 20 maxResponseMs: 279 - id: 019d9ee8-2d69-70ce-aee3-4d45a01dda3b status: failed timestamp: '2026-04-18T04:45:09.245Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1506 performance: minResponseMs: 16 maxResponseMs: 250 - id: 019d9ee3-a669-7e8c-8bb3-f10e7e557081 status: failed timestamp: '2026-04-18T04:40:12.552Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1815 performance: minResponseMs: 16 maxResponseMs: 355 - id: 019d9ecc-a81a-7999-8044-6052538df819 status: failed timestamp: '2026-04-18T04:15:05.635Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1420 performance: minResponseMs: 19 maxResponseMs: 231 - id: 019d9ec8-10bb-7033-ac29-5e8cc9e254b2 status: failed timestamp: '2026-04-18T04:10:04.743Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1512 performance: minResponseMs: 17 maxResponseMs: 285 - id: 019d9ec3-9a04-7722-8732-43ff3eba4ede status: failed timestamp: '2026-04-18T04:05:12.214Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1661 performance: minResponseMs: 19 maxResponseMs: 256 - id: 019d9ebf-2052-7f7c-9e09-e9fcde166030 status: failed timestamp: '2026-04-18T04:00:18.914Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1699 performance: minResponseMs: 16 maxResponseMs: 321 - id: 019d9eba-67b8-78b6-83e1-803f8b60bae5 status: failed timestamp: '2026-04-18T03:55:09.525Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1454 performance: minResponseMs: 16 maxResponseMs: 233 - id: 019d9eb1-4546-766b-bfdd-0bf0667c2daa status: failed timestamp: '2026-04-18T03:45:10.866Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1641 performance: minResponseMs: 17 maxResponseMs: 231 - id: 019d9ea8-1eea-76da-be6d-1bbef4e1d596 status: failed timestamp: '2026-04-18T03:35:11.231Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1476 performance: minResponseMs: 18 maxResponseMs: 251 - id: 019d9ea3-b5fa-77c2-a31f-e95ec3c2f83a status: failed timestamp: '2026-04-18T03:30:22.230Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1444 performance: minResponseMs: 18 maxResponseMs: 256 - id: 019d9e9e-ef46-791b-be86-0396ffc86829 status: failed timestamp: '2026-04-18T03:25:09.181Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1667 performance: minResponseMs: 16 maxResponseMs: 261 - id: 019d9e95-c8cf-7b24-ba48-8b0755230c3a status: failed timestamp: '2026-04-18T03:15:09.532Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1479 performance: minResponseMs: 17 maxResponseMs: 267 - id: 019d9e91-382c-7dd3-9db9-e69b29fb5ac4 status: failed timestamp: '2026-04-18T03:10:10.367Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1562 performance: minResponseMs: 19 maxResponseMs: 258 - id: 019d9e71-1d99-7e90-821e-8643f7742596 status: failed timestamp: '2026-04-18T02:35:06.427Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1518 performance: minResponseMs: 17 maxResponseMs: 287 - id: 019d9e6c-98b5-76f7-a380-9ffd3ebbe482 status: failed timestamp: '2026-04-18T02:30:10.253Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1488 performance: minResponseMs: 20 maxResponseMs: 251 - id: 019d9e63-6188-7eb0-8ed2-f8f4507d4070 status: failed timestamp: '2026-04-18T02:20:06.290Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1628 performance: minResponseMs: 21 maxResponseMs: 271 - id: 019d9e5a-357e-71b9-94a0-f206c41a8d4f status: failed timestamp: '2026-04-18T02:10:05.194Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1444 performance: minResponseMs: 15 maxResponseMs: 257 - id: 019d9e47-f09c-7683-8ff0-2e439392fe97 status: failed timestamp: '2026-04-18T01:50:07.910Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1671 performance: minResponseMs: 19 maxResponseMs: 231 - id: 019d9e43-4e49-78e3-b6bc-e4a3daa55e7d status: failed timestamp: '2026-04-18T01:45:04.214Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1524 performance: minResponseMs: 19 maxResponseMs: 285 getApiCatalogServiceMonitorRunsFilterByCollectionId: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 collectionId: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b timeRange: start: '2026-04-14T13:37:15.359Z' end: '2026-04-21T13:37:15.359Z' label: last_7_days totalRuns: 1026 passedRuns: 454 failedRuns: 572 successRatePct: 44.25 data: - id: 019d9ef1-4441-7d5d-892b-cf280e19c12d status: passed timestamp: '2026-04-18T04:55:04.898Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1747 performance: minResponseMs: 17 maxResponseMs: 308 - id: 019d9eec-b572-7ea0-a76f-be24a3fa9e65 status: failed timestamp: '2026-04-18T04:50:06.226Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1666 performance: minResponseMs: 20 maxResponseMs: 279 - id: 019d9ee8-2d69-70ce-aee3-4d45a01dda3b status: failed timestamp: '2026-04-18T04:45:09.245Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1506 performance: minResponseMs: 16 maxResponseMs: 250 - id: 019d9ee3-a669-7e8c-8bb3-f10e7e557081 status: failed timestamp: '2026-04-18T04:40:12.552Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1815 performance: minResponseMs: 16 maxResponseMs: 355 - id: 019d9edf-039c-73d5-ab3d-38c4dbacb5c9 status: passed timestamp: '2026-04-18T04:35:08.737Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1607 performance: minResponseMs: 18 maxResponseMs: 325 - id: 019d9eda-7278-7f26-869d-c140559c4114 status: passed timestamp: '2026-04-18T04:30:09.422Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1404 performance: minResponseMs: 17 maxResponseMs: 240 - id: 019d9ed5-ecc8-72b7-bff8-52f74e7643cb status: passed timestamp: '2026-04-18T04:25:13.026Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1696 performance: minResponseMs: 17 maxResponseMs: 281 - id: 019d9ed1-5a43-7e05-a076-ea4478cba9f8 status: passed timestamp: '2026-04-18T04:20:13.390Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1799 performance: minResponseMs: 19 maxResponseMs: 304 - id: 019d9ecc-a81a-7999-8044-6052538df819 status: failed timestamp: '2026-04-18T04:15:05.635Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1420 performance: minResponseMs: 19 maxResponseMs: 231 - id: 019d9ec8-10bb-7033-ac29-5e8cc9e254b2 status: failed timestamp: '2026-04-18T04:10:04.743Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1512 performance: minResponseMs: 17 maxResponseMs: 285 - id: 019d9ec3-9a04-7722-8732-43ff3eba4ede status: failed timestamp: '2026-04-18T04:05:12.214Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1661 performance: minResponseMs: 19 maxResponseMs: 256 - id: 019d9ebf-2052-7f7c-9e09-e9fcde166030 status: failed timestamp: '2026-04-18T04:00:18.914Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1699 performance: minResponseMs: 16 maxResponseMs: 321 - id: 019d9eba-67b8-78b6-83e1-803f8b60bae5 status: failed timestamp: '2026-04-18T03:55:09.525Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1454 performance: minResponseMs: 16 maxResponseMs: 233 - id: 019d9eb5-cea5-7c95-875b-c9bcb87c7cf3 status: passed timestamp: '2026-04-18T03:50:08.215Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 2052 performance: minResponseMs: 17 maxResponseMs: 421 - id: 019d9eb1-4546-766b-bfdd-0bf0667c2daa status: failed timestamp: '2026-04-18T03:45:10.866Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1641 performance: minResponseMs: 17 maxResponseMs: 231 - id: 019d9eac-9d81-775f-9a93-f1363b151960 status: passed timestamp: '2026-04-18T03:40:05.781Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1671 performance: minResponseMs: 19 maxResponseMs: 299 - id: 019d9ea8-1eea-76da-be6d-1bbef4e1d596 status: failed timestamp: '2026-04-18T03:35:11.231Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1476 performance: minResponseMs: 18 maxResponseMs: 251 - id: 019d9ea3-b5fa-77c2-a31f-e95ec3c2f83a status: failed timestamp: '2026-04-18T03:30:22.230Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1444 performance: minResponseMs: 18 maxResponseMs: 256 - id: 019d9e9e-ef46-791b-be86-0396ffc86829 status: failed timestamp: '2026-04-18T03:25:09.181Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 1 durationMs: 1667 performance: minResponseMs: 16 maxResponseMs: 261 - id: 019d9e9a-4e68-7aff-99ef-b813644df20f status: passed timestamp: '2026-04-18T03:20:05.884Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 12345678-9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' summary: totalRequests: 16 failedRequests: 0 totalAssertions: 56 failedAssertions: 0 durationMs: 1782 performance: minResponseMs: 20 maxResponseMs: 332 getApiCatalogServiceSpecificationLintsSuccessfulResponse: value: meta: nextCursor: null limit: 20 filters: {} timeRange: start: '2026-04-14T13:43:59.525Z' end: '2026-04-21T13:43:59.525Z' label: last_7_days totalRuns: 2 passedRuns: 2 failedRuns: 0 conformanceRatePct: 100 data: - specId: 4c2e5d66-dd5a-43ea-a669-112f16ad48b4 specName: ACS E2E Spec specType: OPENAPI:3.0 timestamp: '2026-04-19T12:08:43.110Z' status: passed issues: errors: 0 warnings: 15 info: 0 - specId: 4c2e5d66-dd5a-43ea-a669-112f16ad48b4 specName: ACS E2E Spec specType: OPENAPI:3.0 timestamp: '2026-04-16T03:49:56.069Z' status: passed issues: errors: 0 warnings: 15 info: 0 getApiCatalogServiceSpecificationLintsResponseWithPagination: value: meta: nextCursor: NzI0MTIzOTgsYWktc2VydmljZQ== limit: 1 filters: {} timeRange: start: '2026-04-14T15:04:48.894Z' end: '2026-04-21T15:04:48.894Z' label: last_7_days totalRuns: 2 passedRuns: 2 failedRuns: 0 conformanceRatePct: 100 data: - specId: 4c2e5d66-dd5a-43ea-a669-112f16ad48b4 specName: ACS E2E Spec specType: OPENAPI:3.0 timestamp: '2026-04-16T03:49:56.069Z' status: passed issues: errors: 0 warnings: 15 info: 0 getApiCatalogServiceSpecificationLintsFilterWithSort: value: meta: nextCursor: null limit: 20 filters: sort: timestamp:asc timeRange: start: '2026-04-14T14:56:31.441Z' end: '2026-04-21T14:56:31.441Z' label: last_7_days totalRuns: 2 passedRuns: 2 failedRuns: 0 conformanceRatePct: 100 data: - specId: 4c2e5d66-dd5a-43ea-a669-112f16ad48b4 specName: ACS E2E Spec specType: OPENAPI:3.0 timestamp: '2026-04-16T03:49:56.069Z' status: passed issues: errors: 0 warnings: 15 info: 0 - specId: 4c2e5d66-dd5a-43ea-a669-112f16ad48b4 specName: ACS E2E Spec specType: OPENAPI:3.0 timestamp: '2026-04-19T12:08:43.110Z' status: passed issues: errors: 0 warnings: 15 info: 0 getApiCatalogServiceSpecificationLintsFilterBySpecId: value: meta: nextCursor: null limit: 20 filters: specId: 4c2e5d66-dd5a-43ea-a669-112f16ad48b4 timeRange: start: '2026-04-14T14:55:54.248Z' end: '2026-04-21T14:55:54.248Z' label: last_7_days totalRuns: 2 passedRuns: 2 failedRuns: 0 conformanceRatePct: 100 data: - specId: 4c2e5d66-dd5a-43ea-a669-112f16ad48b4 specName: ACS E2E Spec specType: OPENAPI:3.0 timestamp: '2026-04-19T12:08:43.110Z' status: passed issues: errors: 0 warnings: 15 info: 0 - specId: 4c2e5d66-dd5a-43ea-a669-112f16ad48b4 specName: ACS E2E Spec specType: OPENAPI:3.0 timestamp: '2026-04-16T03:49:56.069Z' status: passed issues: errors: 0 warnings: 15 info: 0 getApiCatalogServiceSpecificationLintsFilterByStatus: value: meta: nextCursor: null limit: 20 filters: status: passed timeRange: start: '2026-04-14T14:57:01.257Z' end: '2026-04-21T14:57:01.257Z' label: last_7_days totalRuns: 2 passedRuns: 2 failedRuns: 0 conformanceRatePct: 100 data: - specId: 4c2e5d66-dd5a-43ea-a669-112f16ad48b4 specName: ACS E2E Spec specType: OPENAPI:3.0 timestamp: '2026-04-19T12:08:43.110Z' status: passed issues: errors: 0 warnings: 15 info: 0 - specId: 4c2e5d66-dd5a-43ea-a669-112f16ad48b4 specName: ACS E2E Spec specType: OPENAPI:3.0 timestamp: '2026-04-16T03:49:56.069Z' status: passed issues: errors: 0 warnings: 15 info: 0 getApiCatalogServiceSpecificationLintsFilterBySeverity: value: meta: nextCursor: null limit: 20 filters: severity: warning timeRange: start: '2026-04-14T15:04:00.883Z' end: '2026-04-21T15:04:00.883Z' label: last_7_days totalRuns: 2 passedRuns: 2 failedRuns: 0 conformanceRatePct: 100 data: - specId: 4c2e5d66-dd5a-43ea-a669-112f16ad48b4 specName: ACS E2E Spec specType: OPENAPI:3.0 timestamp: '2026-04-19T12:08:43.110Z' status: passed issues: errors: 0 warnings: 15 info: 0 - specId: 4c2e5d66-dd5a-43ea-a669-112f16ad48b4 specName: ACS E2E Spec specType: OPENAPI:3.0 timestamp: '2026-04-16T03:49:56.069Z' status: passed issues: errors: 0 warnings: 15 info: 0 getApiCatalogServiceCiRunsSuccessfulResponse: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 timeRange: start: '2026-04-14T15:05:48.296Z' end: '2026-04-21T15:05:48.296Z' label: last_7_days totalRuns: 7 passedRuns: 4 failedRuns: 3 successRatePct: 57.14 data: - id: 27ace2f7-5130-4405-8489-5ce1ebee322e status: passed timestamp: '2026-04-16T03:56:54.372Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30001' jobName: run-tests jobId: null pipelineId: '30001' pipelineNumber: '100' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 12268 performance: minResponseMs: 305.3381669999999 maxResponseMs: 1951.075459 - id: c23b8c02-540e-4428-8de7-5bb3db0d88e5 status: failed timestamp: '2026-04-16T03:56:37.757Z' collection: id: 1404173-528df970-ceec-45a5-9f72-187ea19ff53b name: '[E2E] Access Control Service #E2ETesting' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: feature/add-auth commitSha: b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3 repo: name: api-catalog-service owner: acs-team url: https://github.com/acs-team/api-catalog-service pullRequest: number: 42 title: Add OAuth2 authentication status: open author: taylor-lee baseBranch: develop headBranch: feature/add-auth pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30002' jobName: run-tests jobId: null pipelineId: '30002' pipelineNumber: '101' runAttempt: 1 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 5.15.0-1051-aws cpus: 4 memoryMb: 15746 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 12341 performance: minResponseMs: 303.39554099999987 maxResponseMs: 1959.3894169999999 - id: 661b381f-1a7a-4e00-a9f6-0458ce77ecb1 status: failed timestamp: '2026-04-16T03:56:05.307Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: feature/add-auth commitSha: c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: number: 42 title: Add OAuth2 authentication status: open author: taylor-lee baseBranch: develop headBranch: feature/add-auth pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30003' jobName: run-tests jobId: null pipelineId: '30003' pipelineNumber: '102' runAttempt: 2 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 5.15.0-1051-aws cpus: 4 memoryMb: 15746 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 13334 performance: minResponseMs: 327.5639169999995 maxResponseMs: 2275.2597920000003 - id: cf2766f1-7ec9-4192-8769-f4c3147d7218 status: failed timestamp: '2026-04-15T16:54:12.795Z' collection: id: 1404173-528df970-ceec-45a5-9f72-187ea19ff53b name: '[E2E] Access Control Service #E2ETesting' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: main commitSha: d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5 repo: name: acs-runtime owner: acs-team url: https://gitlab.com/acs-team/acs-runtime pullRequest: null pipeline: provider: gitlab-ci workflowName: Deploy Pipeline workflowId: '40001' jobName: api-tests jobId: 40001-job pipelineId: '40001' pipelineNumber: '55' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.28.0 system: os: linux 5.15.0-1051-aws cpus: 2 memoryMb: 7873 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 12792 performance: minResponseMs: 307.7815420000006 maxResponseMs: 2033.1472079999999 - id: bbc09eac-e0a5-46e3-97ae-03d98d375a96 status: passed timestamp: '2026-04-15T16:43:00.781Z' collection: id: 1404173-528df970-ceec-45a5-9f72-187ea19ff53b name: '[E2E] Access Control Service #E2ETesting' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: release/v2.0 commitSha: e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6 repo: name: acs-sdk owner: acs-team url: https://github.com/acs-team/acs-sdk pullRequest: number: 88 title: Release v2.0.0 status: merged author: taylor-lee baseBranch: main headBranch: release/v2.0 pipeline: provider: github-actions workflowName: Release Tests workflowId: '30004' jobName: smoke-tests jobId: null pipelineId: '30004' pipelineNumber: '103' runAttempt: 1 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 16578 performance: minResponseMs: 390.8125409999993 maxResponseMs: 2759.324709 - id: 6ea531b8-f20a-439b-b64e-15c8eb77aaca status: passed timestamp: '2026-04-15T16:24:14.654Z' collection: id: 1404173-528df970-ceec-45a5-9f72-187ea19ff53b name: '[E2E] Access Control Service #E2ETesting' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30005' jobName: run-tests jobId: null pipelineId: '30005' pipelineNumber: '104' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 13036 performance: minResponseMs: 307.87195900000006 maxResponseMs: 2233.1558330000007 - id: e1f904c4-538f-460c-8169-ea793b57f764 status: passed timestamp: '2026-04-15T16:22:31.104Z' collection: id: 1404173-528df970-ceec-45a5-9f72-187ea19ff53b name: '[E2E] Access Control Service #E2ETesting' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: a7b8c9d0e1f2a7b8c9d0e1f2a7b8c9d0e1f2a7b8 repo: name: acs-newman owner: acs-team url: https://github.com/acs-team/acs-newman pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30006' jobName: run-tests jobId: null pipelineId: '30006' pipelineNumber: '105' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 13263 performance: minResponseMs: 307.04799999999886 maxResponseMs: 2621.059167 getApiCatalogServiceCiRunsResponseWithPagination: value: meta: nextCursor: NzI0MTIzOTgsYWktc2VydmljZQ== limit: 3 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 timeRange: start: '2026-04-14T15:06:29.751Z' end: '2026-04-21T15:06:29.751Z' label: last_7_days totalRuns: 7 passedRuns: 4 failedRuns: 3 successRatePct: 57.14 data: - id: cf2766f1-7ec9-4192-8769-f4c3147d7218 status: failed timestamp: '2026-04-15T16:54:12.795Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: main commitSha: d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5 repo: name: acs-runtime owner: acs-team url: https://gitlab.com/acs-team/acs-runtime pullRequest: null pipeline: provider: gitlab-ci workflowName: Deploy Pipeline workflowId: '40001' jobName: api-tests jobId: 40001-job pipelineId: '40001' pipelineNumber: '55' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.28.0 system: os: linux 5.15.0-1051-aws cpus: 2 memoryMb: 7873 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 12792 performance: minResponseMs: 307.7815420000006 maxResponseMs: 2033.1472079999999 - id: bbc09eac-e0a5-46e3-97ae-03d98d375a96 status: passed timestamp: '2026-04-15T16:43:00.781Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: release/v2.0 commitSha: e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6 repo: name: acs-sdk owner: acs-team url: https://github.com/acs-team/acs-sdk pullRequest: number: 88 title: Release v2.0.0 status: merged author: taylor-lee baseBranch: main headBranch: release/v2.0 pipeline: provider: github-actions workflowName: Release Tests workflowId: '30004' jobName: smoke-tests jobId: null pipelineId: '30004' pipelineNumber: '103' runAttempt: 1 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 16578 performance: minResponseMs: 390.8125409999993 maxResponseMs: 2759.324709 - id: 6ea531b8-f20a-439b-b64e-15c8eb77aaca status: passed timestamp: '2026-04-15T16:24:14.654Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[E2E] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30005' jobName: run-tests jobId: null pipelineId: '30005' pipelineNumber: '104' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 13036 performance: minResponseMs: 307.87195900000006 maxResponseMs: 2233.1558330000007 getApiCatalogServiceCiRunsFilterByCollection: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 collectionId: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b timeRange: start: '2026-04-14T15:06:56.957Z' end: '2026-04-21T15:06:56.957Z' label: last_7_days totalRuns: 7 passedRuns: 4 failedRuns: 3 successRatePct: 57.14 data: - id: 27ace2f7-5130-4405-8489-5ce1ebee322e status: passed timestamp: '2026-04-16T03:56:54.372Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30001' jobName: run-tests jobId: null pipelineId: '30001' pipelineNumber: '100' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 12268 performance: minResponseMs: 305.3381669999999 maxResponseMs: 1951.075459 - id: c23b8c02-540e-4428-8de7-5bb3db0d88e5 status: failed timestamp: '2026-04-16T03:56:37.757Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: feature/add-auth commitSha: b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: number: 42 title: Add OAuth2 authentication status: open author: taylor-lee baseBranch: develop headBranch: feature/add-auth pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30002' jobName: run-tests jobId: null pipelineId: '30002' pipelineNumber: '101' runAttempt: 1 actor: alex-dev execution: cliVersion: 1.29.5 system: os: linux 5.15.0-1051-aws cpus: 4 memoryMb: 15746 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 12341 performance: minResponseMs: 303.39554099999987 maxResponseMs: 1959.3894169999999 - id: 661b381f-1a7a-4e00-a9f6-0458ce77ecb1 status: failed timestamp: '2026-04-16T03:56:05.307Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: feature/add-auth commitSha: c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: number: 42 title: Add OAuth2 authentication status: open author: alex-dev baseBranch: develop headBranch: feature/add-auth pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30003' jobName: run-tests jobId: null pipelineId: '30003' pipelineNumber: '102' runAttempt: 2 actor: alex-dev execution: cliVersion: 1.29.5 system: os: linux 5.15.0-1051-aws cpus: 4 memoryMb: 15746 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 13334 performance: minResponseMs: 327.5639169999995 maxResponseMs: 2275.2597920000003 - id: cf2766f1-7ec9-4192-8769-f4c3147d7218 status: failed timestamp: '2026-04-15T16:54:12.795Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[E2E] API Control Service #E2ETesting' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: main commitSha: d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5 repo: name: acs-runtime owner: acs-team url: https://gitlab.com/acs-team/acs-runtime pullRequest: null pipeline: provider: gitlab-ci workflowName: Deploy Pipeline workflowId: '40001' jobName: api-tests jobId: 40001-job pipelineId: '40001' pipelineNumber: '55' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.28.0 system: os: linux 5.15.0-1051-aws cpus: 2 memoryMb: 7873 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 12792 performance: minResponseMs: 307.7815420000006 maxResponseMs: 2033.1472079999999 - id: bbc09eac-e0a5-46e3-97ae-03d98d375a96 status: passed timestamp: '2026-04-15T16:43:00.781Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[E2E] API Control Service #E2ETesting' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: release/v2.0 commitSha: e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6 repo: name: acs-sdk owner: acs-team url: https://github.com/acs-team/acs-sdk pullRequest: number: 88 title: Release v2.0.0 status: merged author: taylor-lee baseBranch: main headBranch: release/v2.0 pipeline: provider: github-actions workflowName: Release Tests workflowId: '30004' jobName: smoke-tests jobId: null pipelineId: '30004' pipelineNumber: '103' runAttempt: 1 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 16578 performance: minResponseMs: 390.8125409999993 maxResponseMs: 2759.324709 - id: 6ea531b8-f20a-439b-b64e-15c8eb77aaca status: passed timestamp: '2026-04-15T16:24:14.654Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[E2E] API Control Service #E2ETesting' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30005' jobName: run-tests jobId: null pipelineId: '30005' pipelineNumber: '104' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 13036 performance: minResponseMs: 307.87195900000006 maxResponseMs: 2233.1558330000007 - id: e1f904c4-538f-460c-8169-ea793b57f764 status: passed timestamp: '2026-04-15T16:22:31.104Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[E2E] API Control Service #E2ETesting' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: a7b8c9d0e1f2a7b8c9d0e1f2a7b8c9d0e1f2a7b8 repo: name: acs-newman owner: acs-team url: https://github.com/acs-team/acs-newman pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30006' jobName: run-tests jobId: null pipelineId: '30006' pipelineNumber: '105' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 13263 performance: minResponseMs: 307.04799999999886 maxResponseMs: 2621.059167 getApiCatalogServiceCiRunsFilterByEnvironment: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 environmentId: 9b83df88-9b5c-445b-ac23-460c37897340 timeRange: start: '2026-04-14T15:07:23.653Z' end: '2026-04-21T15:07:23.653Z' label: last_7_days totalRuns: 7 passedRuns: 4 failedRuns: 3 successRatePct: 57.14 data: - id: 27ace2f7-5130-4405-8489-5ce1ebee322e status: passed timestamp: '2026-04-16T03:56:54.372Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30001' jobName: run-tests jobId: null pipelineId: '30001' pipelineNumber: '100' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 12268 performance: minResponseMs: 305.3381669999999 maxResponseMs: 1951.075459 - id: c23b8c02-540e-4428-8de7-5bb3db0d88e5 status: failed timestamp: '2026-04-16T03:56:37.757Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: feature/add-auth commitSha: b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: number: 42 title: Add OAuth2 authentication status: open author: john-dev baseBranch: develop headBranch: feature/add-auth pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30002' jobName: run-tests jobId: null pipelineId: '30002' pipelineNumber: '101' runAttempt: 1 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 5.15.0-1051-aws cpus: 4 memoryMb: 15746 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 12341 performance: minResponseMs: 303.39554099999987 maxResponseMs: 1959.3894169999999 - id: 661b381f-1a7a-4e00-a9f6-0458ce77ecb1 status: failed timestamp: '2026-04-16T03:56:05.307Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: feature/add-auth commitSha: c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: number: 42 title: Add OAuth2 authentication status: open author: john-dev baseBranch: develop headBranch: feature/add-auth pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30003' jobName: run-tests jobId: null pipelineId: '30003' pipelineNumber: '102' runAttempt: 2 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 5.15.0-1051-aws cpus: 4 memoryMb: 15746 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 13334 performance: minResponseMs: 327.5639169999995 maxResponseMs: 2275.2597920000003 - id: cf2766f1-7ec9-4192-8769-f4c3147d7218 status: failed timestamp: '2026-04-15T16:54:12.795Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: main commitSha: d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5 repo: name: acs-runtime owner: acs-team url: https://gitlab.com/acs-team/acs-runtime pullRequest: null pipeline: provider: gitlab-ci workflowName: Deploy Pipeline workflowId: '40001' jobName: api-tests jobId: 40001-job pipelineId: '40001' pipelineNumber: '55' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.28.0 system: os: linux 5.15.0-1051-aws cpus: 2 memoryMb: 7873 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 12792 performance: minResponseMs: 307.7815420000006 maxResponseMs: 2033.1472079999999 - id: bbc09eac-e0a5-46e3-97ae-03d98d375a96 status: passed timestamp: '2026-04-15T16:43:00.781Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: release/v2.0 commitSha: e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6 repo: name: acs-sdk owner: acs-team url: https://github.com/acs-team/acs-sdk pullRequest: number: 88 title: Release v2.0.0 status: merged author: sarah-lead baseBranch: main headBranch: release/v2.0 pipeline: provider: github-actions workflowName: Release Tests workflowId: '30004' jobName: smoke-tests jobId: null pipelineId: '30004' pipelineNumber: '103' runAttempt: 1 actor: sarah-lead execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 16578 performance: minResponseMs: 390.8125409999993 maxResponseMs: 2759.324709 - id: 6ea531b8-f20a-439b-b64e-15c8eb77aaca status: passed timestamp: '2026-04-15T16:24:14.654Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30005' jobName: run-tests jobId: null pipelineId: '30005' pipelineNumber: '104' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 13036 performance: minResponseMs: 307.87195900000006 maxResponseMs: 2233.1558330000007 - id: e1f904c4-538f-460c-8169-ea793b57f764 status: passed timestamp: '2026-04-15T16:22:31.104Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: a7b8c9d0e1f2a7b8c9d0e1f2a7b8c9d0e1f2a7b8 repo: name: acs-newman owner: acs-team url: https://github.com/acs-team/acs-newman pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30006' jobName: run-tests jobId: null pipelineId: '30006' pipelineNumber: '105' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 13263 performance: minResponseMs: 307.04799999999886 maxResponseMs: 2621.059167 getApiCatalogServiceCiRunsFilterByWorkflowName: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 workflowName: E2E Tests timeRange: start: '2026-04-14T15:09:01.912Z' end: '2026-04-21T15:09:01.912Z' label: last_7_days totalRuns: 5 passedRuns: 3 failedRuns: 2 successRatePct: 60 data: - id: 27ace2f7-5130-4405-8489-5ce1ebee322e status: passed timestamp: '2026-04-16T03:56:54.372Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30001' jobName: run-tests jobId: null pipelineId: '30001' pipelineNumber: '100' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 12268 performance: minResponseMs: 305.3381669999999 maxResponseMs: 1951.075459 - id: c23b8c02-540e-4428-8de7-5bb3db0d88e5 status: failed timestamp: '2026-04-16T03:56:37.757Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: feature/add-auth commitSha: b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: number: 42 title: Add OAuth2 authentication status: open author: taylor-lee baseBranch: develop headBranch: feature/add-auth pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30002' jobName: run-tests jobId: null pipelineId: '30002' pipelineNumber: '101' runAttempt: 1 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 5.15.0-1051-aws cpus: 4 memoryMb: 15746 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 12341 performance: minResponseMs: 303.39554099999987 maxResponseMs: 1959.3894169999999 - id: 661b381f-1a7a-4e00-a9f6-0458ce77ecb1 status: failed timestamp: '2026-04-16T03:56:05.307Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: feature/add-auth commitSha: c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: number: 42 title: Add OAuth2 authentication status: open author: taylor-lee baseBranch: develop headBranch: feature/add-auth pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30003' jobName: run-tests jobId: null pipelineId: '30003' pipelineNumber: '102' runAttempt: 2 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 5.15.0-1051-aws cpus: 4 memoryMb: 15746 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 13334 performance: minResponseMs: 327.5639169999995 maxResponseMs: 2275.2597920000003 - id: 6ea531b8-f20a-439b-b64e-15c8eb77aaca status: passed timestamp: '2026-04-15T16:24:14.654Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30005' jobName: run-tests jobId: null pipelineId: '30005' pipelineNumber: '104' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 13036 performance: minResponseMs: 307.87195900000006 maxResponseMs: 2233.1558330000007 - id: e1f904c4-538f-460c-8169-ea793b57f764 status: passed timestamp: '2026-04-15T16:22:31.104Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: a7b8c9d0e1f2a7b8c9d0e1f2a7b8c9d0e1f2a7b8 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30006' jobName: run-tests jobId: null pipelineId: '30006' pipelineNumber: '105' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 13263 performance: minResponseMs: 307.04799999999886 maxResponseMs: 2621.059167 getApiCatalogServiceCiRunsFilterByActor: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 actor: taylor-lee timeRange: start: '2026-04-14T15:09:33.463Z' end: '2026-04-21T15:09:33.463Z' label: last_7_days totalRuns: 2 passedRuns: 0 failedRuns: 2 successRatePct: 0 data: - id: c23b8c02-540e-4428-8de7-5bb3db0d88e5 status: failed timestamp: '2026-04-16T03:56:37.757Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: feature/add-auth commitSha: b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: number: 42 title: Add OAuth2 authentication status: open author: taylor-lee baseBranch: develop headBranch: feature/add-auth pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30002' jobName: run-tests jobId: null pipelineId: '30002' pipelineNumber: '101' runAttempt: 1 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 5.15.0-1051-aws cpus: 4 memoryMb: 15746 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 12341 performance: minResponseMs: 303.39554099999987 maxResponseMs: 1959.3894169999999 - id: 661b381f-1a7a-4e00-a9f6-0458ce77ecb1 status: failed timestamp: '2026-04-16T03:56:05.307Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: feature/add-auth commitSha: c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: number: 42 title: Add OAuth2 authentication status: open author: taylor-lee baseBranch: develop headBranch: feature/add-auth pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30003' jobName: run-tests jobId: null pipelineId: '30003' pipelineNumber: '102' runAttempt: 2 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 5.15.0-1051-aws cpus: 4 memoryMb: 15746 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 13334 performance: minResponseMs: 327.5639169999995 maxResponseMs: 2275.2597920000003 getApiCatalogServiceCiRunsFilterByRepoName: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 repoName: acs-catalog timeRange: start: '2026-04-14T15:10:02.437Z' end: '2026-04-21T15:10:02.437Z' label: last_7_days totalRuns: 4 passedRuns: 2 failedRuns: 2 successRatePct: 50 data: - id: 27ace2f7-5130-4405-8489-5ce1ebee322e status: passed timestamp: '2026-04-16T03:56:54.372Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30001' jobName: run-tests jobId: null pipelineId: '30001' pipelineNumber: '100' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 12268 performance: minResponseMs: 305.3381669999999 maxResponseMs: 1951.075459 - id: c23b8c02-540e-4428-8de7-5bb3db0d88e5 status: failed timestamp: '2026-04-16T03:56:37.757Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: feature/add-auth commitSha: b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: number: 42 title: Add OAuth2 authentication status: open author: taylor-lee baseBranch: develop headBranch: feature/add-auth pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30002' jobName: run-tests jobId: null pipelineId: '30002' pipelineNumber: '101' runAttempt: 1 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 5.15.0-1051-aws cpus: 4 memoryMb: 15746 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 12341 performance: minResponseMs: 303.39554099999987 maxResponseMs: 1959.3894169999999 - id: 661b381f-1a7a-4e00-a9f6-0458ce77ecb1 status: failed timestamp: '2026-04-16T03:56:05.307Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: feature/add-auth commitSha: c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: number: 42 title: Add OAuth2 authentication status: open author: taylor-lee baseBranch: develop headBranch: feature/add-auth pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30003' jobName: run-tests jobId: null pipelineId: '30003' pipelineNumber: '102' runAttempt: 2 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 5.15.0-1051-aws cpus: 4 memoryMb: 15746 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 13334 performance: minResponseMs: 327.5639169999995 maxResponseMs: 2275.2597920000003 - id: 6ea531b8-f20a-439b-b64e-15c8eb77aaca status: passed timestamp: '2026-04-15T16:24:14.654Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30005' jobName: run-tests jobId: null pipelineId: '30005' pipelineNumber: '104' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 13036 performance: minResponseMs: 307.87195900000006 maxResponseMs: 2233.1558330000007 getApiCatalogServiceCiRunsFilterWithSort: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 sort: duration:desc timeRange: start: '2026-04-14T15:11:20.420Z' end: '2026-04-21T15:11:20.420Z' label: last_7_days totalRuns: 7 passedRuns: 4 failedRuns: 3 successRatePct: 57.14 data: - id: bbc09eac-e0a5-46e3-97ae-03d98d375a96 status: passed timestamp: '2026-04-15T16:43:00.781Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: release/v2.0 commitSha: e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6 repo: name: acs-sdk owner: acs-team url: https://github.com/acs-team/acs-sdk pullRequest: number: 88 title: Release v2.0.0 status: merged author: taylor-lee baseBranch: main headBranch: release/v2.0 pipeline: provider: github-actions workflowName: Release Tests workflowId: '30004' jobName: smoke-tests jobId: null pipelineId: '30004' pipelineNumber: '103' runAttempt: 1 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 16578 performance: minResponseMs: 390.8125409999993 maxResponseMs: 2759.324709 - id: 661b381f-1a7a-4e00-a9f6-0458ce77ecb1 status: failed timestamp: '2026-04-16T03:56:05.307Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: feature/add-auth commitSha: c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: number: 42 title: Add OAuth2 authentication status: open author: taylor-lee baseBranch: develop headBranch: feature/add-auth pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30003' jobName: run-tests jobId: null pipelineId: '30003' pipelineNumber: '102' runAttempt: 2 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 5.15.0-1051-aws cpus: 4 memoryMb: 15746 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 13334 performance: minResponseMs: 327.5639169999995 maxResponseMs: 2275.2597920000003 - id: e1f904c4-538f-460c-8169-ea793b57f764 status: passed timestamp: '2026-04-15T16:22:31.104Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: a7b8c9d0e1f2a7b8c9d0e1f2a7b8c9d0e1f2a7b8 repo: name: acs-sdk owner: acs-team url: https://github.com/acs-team/acs-sdk pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30006' jobName: run-tests jobId: null pipelineId: '30006' pipelineNumber: '105' runAttempt: 1 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 13263 performance: minResponseMs: 307.04799999999886 maxResponseMs: 2621.059167 - id: 6ea531b8-f20a-439b-b64e-15c8eb77aaca status: passed timestamp: '2026-04-15T16:24:14.654Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30005' jobName: run-tests jobId: null pipelineId: '30005' pipelineNumber: '104' runAttempt: 1 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 13036 performance: minResponseMs: 307.87195900000006 maxResponseMs: 2233.1558330000007 - id: cf2766f1-7ec9-4192-8769-f4c3147d7218 status: failed timestamp: '2026-04-15T16:54:12.795Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: main commitSha: d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5 repo: name: acs-runtime owner: acs-team url: https://gitlab.com/acs-team/acs-runtime pullRequest: null pipeline: provider: gitlab-ci workflowName: Deploy Pipeline workflowId: '40001' jobName: api-tests jobId: 40001-job pipelineId: '40001' pipelineNumber: '55' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.28.0 system: os: linux 5.15.0-1051-aws cpus: 2 memoryMb: 7873 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 12792 performance: minResponseMs: 307.7815420000006 maxResponseMs: 2033.1472079999999 - id: c23b8c02-540e-4428-8de7-5bb3db0d88e5 status: failed timestamp: '2026-04-16T03:56:37.757Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: feature/add-auth commitSha: b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: number: 42 title: Add OAuth2 authentication status: open author: taylor-lee baseBranch: develop headBranch: feature/add-auth pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30002' jobName: run-tests jobId: null pipelineId: '30002' pipelineNumber: '101' runAttempt: 1 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 5.15.0-1051-aws cpus: 4 memoryMb: 15746 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 12341 performance: minResponseMs: 303.39554099999987 maxResponseMs: 1959.3894169999999 - id: 27ace2f7-5130-4405-8489-5ce1ebee322e status: passed timestamp: '2026-04-16T03:56:54.372Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30001' jobName: run-tests jobId: null pipelineId: '30001' pipelineNumber: '100' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 12268 performance: minResponseMs: 305.3381669999999 maxResponseMs: 1951.075459 getApiCatalogServiceCiRunsFilterByRepoOwner: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 repoOwner: acs-team timeRange: start: '2026-04-14T15:10:53.506Z' end: '2026-04-21T15:10:53.506Z' label: last_7_days totalRuns: 2 passedRuns: 1 failedRuns: 1 successRatePct: 50 data: - id: cf2766f1-7ec9-4192-8769-f4c3147d7218 status: failed timestamp: '2026-04-15T16:54:12.795Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: main commitSha: d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5 repo: name: acs-runtime owner: acs-team url: https://gitlab.com/acs-team/acs-runtime pullRequest: null pipeline: provider: gitlab-ci workflowName: Deploy Pipeline workflowId: '40001' jobName: api-tests jobId: 40001-job pipelineId: '40001' pipelineNumber: '55' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.28.0 system: os: linux 5.15.0-1051-aws cpus: 2 memoryMb: 7873 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 1 durationMs: 12792 performance: minResponseMs: 307.7815420000006 maxResponseMs: 2033.1472079999999 - id: bbc09eac-e0a5-46e3-97ae-03d98d375a96 status: passed timestamp: '2026-04-15T16:43:00.781Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: release/v2.0 commitSha: e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6 repo: name: acs-sdk owner: acs-team url: https://github.com/acs-team/acs-sdk pullRequest: number: 88 title: Release v2.0.0 status: merged author: taylor-lee baseBranch: main headBranch: release/v2.0 pipeline: provider: github-actions workflowName: Release Tests workflowId: '30004' jobName: smoke-tests jobId: null pipelineId: '30004' pipelineNumber: '103' runAttempt: 1 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 16578 performance: minResponseMs: 390.8125409999993 maxResponseMs: 2759.324709 getApiCatalogServiceCiRunsFilterByBranch: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 branch: develop timeRange: start: '2026-04-14T15:08:35.949Z' end: '2026-04-21T15:08:35.949Z' label: last_7_days totalRuns: 3 passedRuns: 3 failedRuns: 0 successRatePct: 100 data: - id: 27ace2f7-5130-4405-8489-5ce1ebee322e status: passed timestamp: '2026-04-16T03:56:54.372Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30001' jobName: run-tests jobId: null pipelineId: '30001' pipelineNumber: '100' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 12268 performance: minResponseMs: 305.3381669999999 maxResponseMs: 1951.075459 - id: 6ea531b8-f20a-439b-b64e-15c8eb77aaca status: passed timestamp: '2026-04-15T16:24:14.654Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30005' jobName: run-tests jobId: null pipelineId: '30005' pipelineNumber: '104' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 13036 performance: minResponseMs: 307.87195900000006 maxResponseMs: 2233.1558330000007 - id: e1f904c4-538f-460c-8169-ea793b57f764 status: passed timestamp: '2026-04-15T16:22:31.104Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: a7b8c9d0e1f2a7b8c9d0e1f2a7b8c9d0e1f2a7b8 repo: name: newman owner: acs-team url: https://github.com/acs-team/newman pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30006' jobName: run-tests jobId: null pipelineId: '30006' pipelineNumber: '105' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 13263 performance: minResponseMs: 307.04799999999886 maxResponseMs: 2621.059167 getApiCatalogServiceCiRunsFilterByStatus: value: meta: nextCursor: null limit: 20 filters: systemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 status: passed timeRange: start: '2026-04-14T15:08:04.790Z' end: '2026-04-21T15:08:04.790Z' label: last_7_days totalRuns: 4 passedRuns: 4 failedRuns: 0 successRatePct: 100 data: - id: 27ace2f7-5130-4405-8489-5ce1ebee322e status: passed timestamp: '2026-04-16T03:56:54.372Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30001' jobName: run-tests jobId: null pipelineId: '30001' pipelineNumber: '100' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 12268 performance: minResponseMs: 305.3381669999999 maxResponseMs: 1951.075459 - id: bbc09eac-e0a5-46e3-97ae-03d98d375a96 status: passed timestamp: '2026-04-15T16:43:00.781Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: release/v2.0 commitSha: e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6 repo: name: acs-sdk owner: acs-team url: https://github.com/acs-team/acs-sdk pullRequest: number: 88 title: Release v2.0.0 status: merged author: taylor-lee baseBranch: main headBranch: release/v2.0 pipeline: provider: github-actions workflowName: Release Tests workflowId: '30004' jobName: smoke-tests jobId: null pipelineId: '30004' pipelineNumber: '103' runAttempt: 1 actor: taylor-lee execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 16578 performance: minResponseMs: 390.8125409999993 maxResponseMs: 2759.324709 - id: 6ea531b8-f20a-439b-b64e-15c8eb77aaca status: passed timestamp: '2026-04-15T16:24:14.654Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1 repo: name: acs-catalog owner: acs-team url: https://github.com/acs-team/acs-catalog pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30005' jobName: run-tests jobId: null pipelineId: '30005' pipelineNumber: '104' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 13036 performance: minResponseMs: 307.87195900000006 maxResponseMs: 2233.1558330000007 - id: e1f904c4-538f-460c-8169-ea793b57f764 status: passed timestamp: '2026-04-15T16:22:31.104Z' collection: id: 12345678-528df970-ceec-45a5-9f72-187ea19ff53b name: '[PROD] API Control Service' environment: id: 9b83df88-9b5c-445b-ac23-460c37897340 name: '[PROD] API Control Service' source: branch: develop commitSha: a7b8c9d0e1f2a7b8c9d0e1f2a7b8c9d0e1f2a7b8 repo: name: acs-sdk owner: acs-team url: https://github.com/acs-team/acs-sdk pullRequest: null pipeline: provider: github-actions workflowName: E2E Tests workflowId: '30006' jobName: run-tests jobId: null pipelineId: '30006' pipelineNumber: '105' runAttempt: 1 actor: deploy-bot execution: cliVersion: 1.29.5 system: os: linux 6.12.46-66.121.amzn2023.aarch64 cpus: 8 memoryMb: 31492 summary: totalRequests: 29 failedRequests: 0 totalAssertions: 97 failedAssertions: 0 durationMs: 13263 performance: minResponseMs: 307.04799999999886 maxResponseMs: 2621.059167 getApiCatalogSystemEnvironmentsSuccessfulResponse: value: meta: total: 100 nextCursor: ZjlkZDAyNTEtZjUxZS00ODdkLTkxY2QtZTE4ZDRkODEwNzc0 limit: 20 data: - id: fffa77cd-fd06-448e-a65d-2f77a0e58dad name: TESTING-1774258301513-4358-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 0 createdAt: '2026-03-23T09:31:41.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fecb4dbd-240a-44e9-89f3-4756d8c1c893 name: TESTING-1772092243420-1818-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 1 createdAt: '2026-02-26T07:50:43.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fde857ad-d590-4f4f-94cd-021d771d88de name: TESTING-1774092688416-7397-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 0 createdAt: '2026-03-21T11:31:28.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fdc88e7d-59ab-46d0-ab37-9827936cd510 name: TESTING-1774189852129-2330-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 0 createdAt: '2026-03-22T14:30:52.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fd741d0d-92bf-4ad8-bfc0-2e9aa0560b12 name: TESTING-1774002637514-7841-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 0 createdAt: '2026-03-20T10:30:37.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fd4ff540-5237-4523-b747-7ed054be18ee name: TESTING-1774510225782-3137-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 0 createdAt: '2026-03-26T07:30:25.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fd31e1bc-edbd-4646-8b76-babc84a4ed5d name: TESTING-1772008838873-9737-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 1 createdAt: '2026-02-25T08:40:38.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fce920ab-86b2-4b22-bd9c-a4e2a827fc22 name: TESTING-1772014970836-9161-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 1 createdAt: '2026-02-25T10:22:50.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fc56a9f2-ef62-401d-8ab6-dc2b3295d48d name: TESTING-1773317381966-6301-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 0 createdAt: '2026-03-12T12:09:42.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fc4a764c-323d-46e2-b35e-54439713b042 name: TESTING-1773772412144-4570-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 0 createdAt: '2026-03-17T18:33:32.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fc2cab54-af34-4b9e-baa3-dacf35083c0d name: TESTING-1774222224868-3587-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 0 createdAt: '2026-03-22T23:30:24.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fc179dfe-8a4e-428b-b77d-338274c47919 name: TESTING-1773147048870-1689-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 0 createdAt: '2026-03-10T12:50:48.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fb16e5c6-916c-4c21-9b87-f7ca23a22890 name: TESTING-1771859323768-2461-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 1 createdAt: '2026-02-23T15:08:43.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fab0f173-32c3-48c6-860e-465343960cee name: TESTING-1771999132205-2781-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 1 createdAt: '2026-02-25T05:58:52.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fa72e62a-942d-4f38-8470-fa8d7cba4c04 name: TESTING-1772727507440-4390-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 0 createdAt: '2026-03-05T16:18:27.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fa50e347-8633-4467-8a9f-b955fd2d0737 name: PRODUCTION-1772023144720-9547-1 label: '' color: '#FF0000' description: Production environment. isProduction: true associationCount: 1 createdAt: '2026-02-25T12:39:04.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fa443806-cb11-41c2-b293-ccbc8a353035 name: PRODUCTION-1773826254026-8166-2 label: '' color: '#FF0000' description: Production environment. isProduction: true associationCount: 0 createdAt: '2026-03-18T09:30:54.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fa1e910c-e092-4eaa-af51-d0a91b7907ff name: PRODUCTION-1772276118050-3585-3 label: '' color: '#FF0000' description: Production environment. isProduction: true associationCount: 0 createdAt: '2026-02-28T10:55:18.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: f9f140fb-4772-405a-904e-db89b357a781 name: PRODUCTION-1774546283561-4747-4 label: '' color: '#FF0000' description: Production environment. isProduction: true associationCount: 0 createdAt: '2026-03-26T17:31:23.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: f9dd0251-f51e-487d-91cd-e18d4d810774 name: PRODUCTION-1771985260417-5689-5 label: '' color: '#FF0000' description: Production environment. isProduction: true associationCount: 1 createdAt: '2026-02-25T02:07:40.000Z' updatedAt: '2026-03-27T17:56:16.000Z' getApiCatalogSystemEnvironmentsFilterByIsProduction: value: meta: total: 1 nextCursor: null limit: 20 filters: isProduction: true data: - id: e34d6213-509d-4b61-94da-8b8c093cb925 name: PRODUCTION label: prod color: '#EF4444' description: Production environment. isProduction: true createdAt: '2026-03-27T11:38:30.000Z' updatedAt: '2026-03-27T12:26:16.000Z' associationCount: 0 getApiCatalogSystemEnvironmentsResponseWithPagination: value: meta: total: 100 nextCursor: ZjlkZDAyNTEtZjUxZS00ODdkLTkxY2QtZTE4ZDRkODEwNzc0 limit: 20 data: - id: fffa77cd-fd06-448e-a65d-2f77a0e58dad name: TESTING-1774258301513-4358-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 0 createdAt: '2026-03-23T09:31:41.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fecb4dbd-240a-44e9-89f3-4756d8c1c893 name: TESTING-1772092243420-1818-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 1 createdAt: '2026-02-26T07:50:43.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fde857ad-d590-4f4f-94cd-021d771d88de name: TESTING-1774092688416-7397-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 0 createdAt: '2026-03-21T11:31:28.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fdc88e7d-59ab-46d0-ab37-9827936cd510 name: TESTING-1774189852129-2330-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 0 createdAt: '2026-03-22T14:30:52.000Z' updatedAt: '2026-03-27T17:56:16.000Z' - id: fd741d0d-92bf-4ad8-bfc0-2e9aa0560b12 name: TESTING-1774002637514-7841-1 label: '' color: '#FF0000' description: Testing environment. isProduction: false associationCount: 0 createdAt: '2026-03-20T10:30:37.000Z' updatedAt: '2026-03-27T17:56:16.000Z' addApiCatalogSystemEnvironmentAssociations400ErrorInsufficientPermissions: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: Insufficient permissions on 1 environment(s). Use ?allowPartial=true to process permitted items. addApiCatalogSystemEnvironmentAssociations400ErrorInsufficientPermissionsAllEnvironments: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: None of the 4 environment(s) could be processed due to insufficient permissions or resolution failures. removeApiCatalogSystemEnvironmentAssociations400ErrorInvalidPayload: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: 'Validation Error: workspaceEnvironmentIds.0: Must be a UUID or - format, workspaceEnvironmentIds.1: Must be a UUID or - format' errors: - path: workspaceEnvironmentIds.0 message: Must be a UUID or - format - path: workspaceEnvironmentIds.1 message: Must be a UUID or - format updateApiCatalogSystemEnvironment400ErrorInvalidPayload: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: 'Validation Error: At least one field (name, color, description, isProduction) must be provided' errors: - path: '' message: At least one field (name, color, description, isProduction) must be provided apiCatalogSystemEnvironment400ErrorInvalidSystemEnvironmentId: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: 'Validation Error: systemEnvironmentId: Must be a valid UUID' errors: - path: systemEnvironmentId message: Must be a valid UUID getApiCatalog400ErrorInvalidCursor: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: 'Validation Error: cursor: Invalid cursor' errors: - path: cursor message: Invalid cursor getApiCatalog400ErrorInvalidLimit: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: 'Validation Error: limit: limit must not exceed 100' errors: - path: limit message: limit must not exceed 100 createApiCatalogSystemEnvironment400ErrorNameRequired: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: 'Validation Error: name: Name is required' errors: - path: name message: Name is required createApiCatalogSystemEnvironment400ErrorInvalidColorValue: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: 'Validation Error: color: Must be a valid hex color (e.g., #FF5733)' errors: - path: color message: 'Must be a valid hex color (e.g., #FF5733)' createApiCatalogSystemEnvironment: value: name: ALPHA label: alpha description: This is the ALPHA environment color: '#00FF00' isProduction: false createApiCatalogSystemEnvironmentSuccessfulResponse: value: data: id: 019d3dca-5e16-7bba-9f13-7abf00a6a443 name: ALPHA label: alpha color: '#00FF00' description: This is the ALPHA environment isProduction: false createdAt: '2026-03-30T08:09:25.781Z' updatedAt: '2026-03-30T08:09:25.781Z' apiCatalogSystemEnvironment409ErrorConflictingName: value: type: https://api.postman.com/problems/conflict status: 409 title: Conflict detail: System environment with this name already exists getApiCatalogSystemEnvironmentSuccessfulResponse: value: data: id: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 name: BETA label: beta color: '#F7F13B' description: This is the BETA environment isProduction: false associationCount: 11 createdAt: '2026-02-23T11:54:16.000Z' updatedAt: '2026-03-27T17:56:16.000Z' apiCatalogSystemEnvironment404ErrorSystemEnvironmentNotFound: value: type: https://api.postman.com/problems/not-found status: 404 title: Not Found detail: System environment not found updateApiCatalogSystemEnvironment: value: name: US-BETA description: This is a beta environment for testing US data center. color: '#FFFFFF' isProduction: false updateApiCatalogSystemEnvironmentSuccessfulResponse: value: data: id: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 name: US-BETA label: beta-testing color: '#FFFFFF' description: This is a beta environment for testing US data center. isProduction: false createdAt: '2026-02-23T06:24:16.000Z' updatedAt: '2026-03-30T09:02:37.190Z' getApiCatalogSystemEnvironmentAssociationsSuccessfulResponse: value: meta: total: 11 nextCursor: null limit: 20 data: - id: ff53b4bc-eeb7-4b13-866a-5fbd79b13137 workspaceEnvironmentId: 12345678-10ec194c-01eb-4844-91a2-9612fccf59d9 workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: d17e1e36-39e8-420b-8eab-52bbd6a9d414 workspaceEnvironmentId: 56781234-6c30365c-aa38-4f6f-b544-c8b06acfc48d workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: cb302fe2-0c2b-48cb-be0f-64a265e153e0 workspaceEnvironmentId: 87654321-3610b709-275b-488d-9f30-5730fc999905 workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: c248ee20-b817-40f1-bcce-09d4cf4987a6 workspaceEnvironmentId: 54367812-0877b33f-3fb2-4a9c-b11e-dc634d9b24d0 workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: 7e63f482-458c-453c-83f8-dc29f49b00b1 workspaceEnvironmentId: 12345678-46ea6b0e-2fa7-40f4-afe1-2e409724d41c workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: 4980cc10-47d1-4a95-8ded-a09a5eeec82a workspaceEnvironmentId: 98765432-c7019db3-a205-4f93-a206-d00d6b6bacdc workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: 370e1614-908a-4c2c-8bec-3c39d332ae52 workspaceEnvironmentId: 56781234-9b6b55ca-b360-4e4a-849e-f92f42fc65d1 workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: 35a2854b-e2f7-446f-a348-0b95f75df74c workspaceEnvironmentId: 87654321-7bc7da32-a085-474e-b0e9-40d4c19cc44c workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: 25bb736a-810a-480d-b86d-df559c5168ee workspaceEnvironmentId: 12345678-f58a2d9c-36de-4129-b96b-d58f7e7f4515 workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: 155e18fb-0a9c-4a91-b56a-f19ff91e2b6d workspaceEnvironmentId: 87612345-8fdcad35-154c-4c65-8bb9-fea0154593ca workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: 27ac7da9-a959-4838-b078-d36bb2495e83 workspaceEnvironmentId: 56781234-eb1a9234-1f61-4f96-9e75-23b333137326 workspaceId: cde1bae5-e2cc-46c2-8d1b-e3d396b3b897 associatedAt: '2026-03-20T11:12:28.000Z' getApiCatalogSystemEnvironmentAssociationsFilterByWorkspaceId: value: meta: total: 11 nextCursor: null limit: 20 data: - id: ff53b4bc-eeb7-4b13-866a-5fbd79b13137 workspaceEnvironmentId: 12345678-10ec194c-01eb-4844-91a2-9612fccf59d9 workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: d17e1e36-39e8-420b-8eab-52bbd6a9d414 workspaceEnvironmentId: 56781234-6c30365c-aa38-4f6f-b544-c8b06acfc48d workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: cb302fe2-0c2b-48cb-be0f-64a265e153e0 workspaceEnvironmentId: 87654321-3610b709-275b-488d-9f30-5730fc999905 workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: c248ee20-b817-40f1-bcce-09d4cf4987a6 workspaceEnvironmentId: 54367812-0877b33f-3fb2-4a9c-b11e-dc634d9b24d0 workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: 7e63f482-458c-453c-83f8-dc29f49b00b1 workspaceEnvironmentId: 12345678-46ea6b0e-2fa7-40f4-afe1-2e409724d41c workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: 4980cc10-47d1-4a95-8ded-a09a5eeec82a workspaceEnvironmentId: 98765432-c7019db3-a205-4f93-a206-d00d6b6bacdc workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: 370e1614-908a-4c2c-8bec-3c39d332ae52 workspaceEnvironmentId: 56781234-9b6b55ca-b360-4e4a-849e-f92f42fc65d1 workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: 35a2854b-e2f7-446f-a348-0b95f75df74c workspaceEnvironmentId: 87654321-7bc7da32-a085-474e-b0e9-40d4c19cc44c workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: 25bb736a-810a-480d-b86d-df559c5168ee workspaceEnvironmentId: 12345678-f58a2d9c-36de-4129-b96b-d58f7e7f4515 workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: 155e18fb-0a9c-4a91-b56a-f19ff91e2b6d workspaceEnvironmentId: 87612345-8fdcad35-154c-4c65-8bb9-fea0154593ca workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' getApiCatalogSystemEnvironmentAssociationsResponseWithPagination: value: meta: total: 11 nextCursor: MTU1ZTE4ZmItMGE5Yy00YTkxLWI1NmEtZjE5ZmY5MWUyYjZk limit: 5 data: - id: ff53b4bc-eeb7-4b13-866a-5fbd79b13137 workspaceEnvironmentId: 12345678-10ec194c-01eb-4844-91a2-9612fccf59d9 workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: d17e1e36-39e8-420b-8eab-52bbd6a9d414 workspaceEnvironmentId: 56781234-6c30365c-aa38-4f6f-b544-c8b06acfc48d workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: cb302fe2-0c2b-48cb-be0f-64a265e153e0 workspaceEnvironmentId: 87654321-3610b709-275b-488d-9f30-5730fc999905 workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: c248ee20-b817-40f1-bcce-09d4cf4987a6 workspaceEnvironmentId: 54367812-0877b33f-3fb2-4a9c-b11e-dc634d9b24d0 workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' - id: 7e63f482-458c-453c-83f8-dc29f49b00b1 workspaceEnvironmentId: 12345678-46ea6b0e-2fa7-40f4-afe1-2e409724d41c workspaceId: 47d1b387-2485-482a-bf62-46ddd70a6d1e associatedAt: '2026-03-17T09:48:14.000Z' addApiCatalogSystemEnvironmentAssociations: value: workspaceEnvironmentIds: - 12345678-4b076607-09cf-4f9d-8a9a-08c8f3cf4619 - 56781234-c71c146a-ee75-4e3d-b1c4-dacc28577ffa - 87654321-9b83df88-9b5c-445b-ac23-460c37897340 addApiCatalogSystemEnvironmentAssociationsSuccessfulResponse: value: meta: created: 1 existing: 1 replaced: 1 excluded: 0 data: - id: 019d3e30-6768-7770-91f0-a2010c886619 workspaceEnvironmentId: 12345678-4b076607-09cf-4f9d-8a9a-08c8f3cf4619 workspaceId: 4540d410-ef72-4977-afb8-d7f53705f379 associatedAt: '2026-03-30T04:30:52.000Z' status: existing - id: 019d3e31-323f-7770-91f0-b2c7d9b0ca21 workspaceEnvironmentId: 56781234-c71c146a-ee75-4e3d-b1c4-dacc28577ffa workspaceId: a5edcd30-c773-4f88-9660-9590bc0af96b associatedAt: '2026-03-30T10:01:44.767Z' status: replaced previousSystemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 - id: 019d3e31-323f-7770-91f0-bc5a64c75930 workspaceEnvironmentId: 87654321-9b83df88-9b5c-445b-ac23-460c37897340 workspaceId: a5450abd-ec89-443c-a17a-68132e738714 associatedAt: '2026-03-30T10:01:44.767Z' status: created addApiCatalogSystemEnvironmentAssociationsResponseWithAllowPartial: value: meta: created: 1 existing: 1 replaced: 1 excluded: 1 data: - workspaceEnvironmentId: 12387654-9b83df88-9b5c-445b-12bc-460c37897340 status: excluded reason: Access denied - id: 019d3e38-bf02-7770-91f0-cc0968a15129 workspaceEnvironmentId: 12345678-4b076607-09cf-4f9d-8a9a-08c8f3cf4619 workspaceId: 4540d410-ef72-4977-afb8-d7f53705f379 associatedAt: '2026-03-30T04:39:59.000Z' status: existing - id: 019d3e3a-8185-7770-91f0-d10f7a05076a workspaceEnvironmentId: 56781234-c71c146a-ee75-4e3d-b1c4-dacc28577ffa workspaceId: a5edcd30-c773-4f88-9660-9590bc0af96b associatedAt: '2026-03-30T10:11:54.884Z' status: replaced previousSystemEnvironmentId: 23b554c1-c30c-483d-bf98-dbe9ab7b88a0 - id: 019d3e3a-8185-7770-91f0-d957ac333230 workspaceEnvironmentId: 87654321-9b83df88-9b5c-445b-ac23-460c37897340 workspaceId: a5450abd-ec89-443c-a17a-68132e738714 associatedAt: '2026-03-30T10:11:54.884Z' status: created removeApiCatalogSystemEnvironmentAssociations: value: workspaceEnvironmentIds: - 12345678-4b076607-09cf-4f9d-8a9a-08c8f3cf4619 - 56781234-c71c146a-ee75-4e3d-b1c4-dacc28577ffb removeApiCatalogSystemEnvironmentAssociationsSuccessfulResponse: value: meta: deleted: 1 notFound: 1 data: - workspaceEnvironmentId: 12345678-4b076607-09cf-4f9d-8a9a-08c8f3cf4619 status: deleted - workspaceEnvironmentId: 56781234-c71c146a-ee75-4e3d-b1c4-dacc28577ffb status: notFound getApis: value: meta: nextCursor: VGh1IE1hciAxNiAyMDIzIDE3OjIxOjUzIEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk= total: 4 limit: 10 apis: - updatedBy: 12345678 createdBy: 12345678 name: New API summary: '' description: '' createdAt: '2023-02-15T06:27:16.000Z' id: 73e15000-bc7a-4802-b80e-05fff18fd7f8 updatedAt: '2023-02-15T06:27:24.000Z' - updatedBy: 12345678 createdBy: 12345678 name: Test API summary: This is a test API. description: This is an API for testing purposes. createdAt: '2023-02-15T13:07:08.000Z' id: fec65321-5f55-4feb-8525-be95bccae8dd updatedAt: '2023-02-15T13:07:08.000Z' - updatedBy: 12345678 createdBy: 12345678 name: Test API summary: This is a test API. description: This is an API for testing purposes. createdAt: '2023-02-16T05:52:27.000Z' id: b7c54faa-d119-4572-a18d-e2f5c32348ce updatedAt: '2023-02-16T05:52:27.000Z' - updatedBy: 12345678 createdBy: 12345678 name: Test API summary: This is a test API. description: This is an API for testing purposes. createdAt: '2023-02-16T07:07:16.000Z' id: d535a8ba-ed4b-4c6a-bf1c-13fac95485b8 updatedAt: '2023-02-16T07:07:16.000Z' common403Error: value: type: https://api.postman.com/problems/forbidden title: Forbidden detail: Forbidden status: 403 common403ErrorPermissions: value: type: https://api.postman.com/problems/forbidden title: Resource cannot be accessed detail: Inadequate permissions. Resource access forbidden. status: 403 common403ErrorForbiddenError: value: error: name: forbiddenError message: You do not have enough permissions to perform this action. common403ErrorWorkspaceAccess: value: type: https://api.postman.com/problems/forbidden title: Forbidden status: 403 detail: You do not have access to this workspace. common403ErrorForbiddenNotAuthorized: value: type: https://api.postman.com/problems/forbidden title: Forbidden detail: You are not authorized to perform this action. status: 403 common403ErrorNoAccessToResource: value: type: https://api.postman.com/problems/forbidden title: Forbidden status: 403 detail: You do not have access to the requested resource. common403ErrorPermissionDenied: value: type: https://api.postman.com/problems/forbidden title: Permission denied status: 403 detail: You do not have permission to perform this action. featureUnavailable403Error: value: type: https://api.postman.com/problems/forbidden title: Forbidden status: 403 detail: This feature isn't available in your region. api404ErrorNotFound: value: type: instanceNotFoundError title: We could not find the API you are looking for detail: We could not find the API you are looking for. api404ErrorInstanceNotFound: value: type: instanceNotFoundError title: Resource not found detail: We could not find the API you are looking for apiVersion404ErrorNotFound: value: type: VersionNotFound title: API Version not found. details: We could not find the API Version you are looking for. apiCollection404ErrorNotFound: value: error: type: instanceNotFoundError title: Collection not found detail: The API does not contain the collection you are looking for apiSchema404ErrorNotFound: value: type: instanceNotFoundError title: Schema not found detail: We could not find a schema linked to this API v9Unsupported: value: type: unsupportedEntityError title: Unsupported API detail: This endpoint does not support v9 APIs. createUpdateApi: value: name: Test API summary: Testing API description: This is a test API. createApiResponse: value: id: 90ca9f5a-c4c4-11ed-afa1-0242ac120002 name: Test API summary: Testing API createdAt: '2023-02-17T04:09:01.000Z' createdBy: 12345678 updatedAt: '2023-02-17T04:09:13.000Z' updatedBy: 12345678 description: This is a test API. workspace400ErrorParamMissing: value: type: paramMissingError title: Parameter is missing in the request. detail: Parameter, workspaceId is missing in the request. api401ErrorUnauthorized: value: type: https://api.postman.com/problems/unauthorized title: Unauthorized detail: An API key must be provided in the request header or query string status: 401 instance: /collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/requests/%7B%7BrequestId%7D%7D api403ErrorForbidden: value: title: You are not permitted to perform the action. detail: Please ensure that you have required permissions type: ForbiddenError api403ErrorLimitReached: value: type: limitReachedError title: You've reached the API limit message: You can create up to 3 APIs on your current plan. detail: model: api action: create message: You can create up to 3 APIs on your current plan. apiSchema403ErrorForbidden: value: title: You are not permitted to perform the action. detail: You do not have access to perform this operation. type: ForbiddenError workspace404Error: value: type: instanceNotFoundError title: We could not find the workspace you are looking for detail: We could not find the workspace you are looking for. getApi: value: createdBy: 12345678 name: Test API updatedBy: 12345678 updatedAt: '2022-06-09T19:50:49.000Z' description: This is a test API. id: 5360b75f-447e-467c-9299-12fd6c92450d collections: - id: 16bb367e-fafb-4ef3-933b-ee3d971866fb gitInfo: {} schemas: - id: ae2b9ab2-28f2-401d-912f-eca09a78e98b versions: - id: 18ccb2dc-1746-4945-ba76-8152b37cr123 name: v1.0.0 createdAt: '2022-06-09T14:48:45.000Z' summary: Test API. v10HeaderMissing: value: name: instanceNotFoundError message: API not found. For v10 and later APIs, ensure that your request sends the "application/vnd.api.v10+json" Accept header. updateApiResponse: value: createdAt: '2022-06-29T20:46:58.000Z' updatedAt: '2022-06-29T20:46:58.000Z' id: 5360b75f-447e-467c-9299-12fd6c92450d name: Test API A summary: Test API A Schema description: This is Test API A. createdBy: '12345678' updatedBy: '12345678' addApiCollectionCopy: value: operationType: COPY_COLLECTION data: collectionId: 12ece9e1-2abf-4edc-8e34-de66e74114d2 addApiCollectionGenerate: value: name: Test Collection operationType: GENERATE_FROM_SCHEMA options: enableOptionalParameters: true folderStrategy: Tags addApiCollectionNew: value: operationType: CREATE_NEW data: item: - protocolProfileBehavior: disableBodyPruning: true response: - originalRequest: url: host: - https://api.postman.com raw: https://api.postman.com/spacecrafts/:spacecraftId variable: - description: (Required) The unique identifier of the spacecraft key: spacecraftId value: path: - spacecrafts - :spacecraftId method: GET header: - description: 'Added as a part of security scheme: apikey' key: X-Api-Key value: code: 200 _postman_previewlanguage: json responseTime: null header: - key: Content-Type value: application/json name: The spacecraft corresponding to the provided `spacecraftId` _postman_previewtype: html body: |- { "id": "", "name": "commodo", "type": "capsule", "description": "pariatur dolo" } cookie: [] status: OK id: 54467f6e-71d7-43d5-acc0-48f948e38528 - originalRequest: url: host: - https://api.postman.com raw: https://api.postman.com/spacecrafts/:spacecraftId variable: - description: (Required) The unique identifier of the spacecraft key: spacecraftId value: path: - spacecrafts - :spacecraftId method: GET header: - description: 'Added as a part of security scheme: apikey' key: X-Api-Key value: code: 404 _postman_previewlanguage: json responseTime: null header: - key: Content-Type value: application/json name: No spacecraft found for the provided `spacecraftId` _postman_previewtype: html body: |- { "message": "dolore Excepteur" } cookie: [] status: Not Found id: 1231609a-7a3d-444d-aa0c-579703e618f4 - originalRequest: url: host: - https://api.postman.com raw: https://api.postman.com/spacecrafts/:spacecraftId variable: - description: (Required) The unique identifier of the spacecraft key: spacecraftId value: path: - spacecrafts - :spacecraftId method: GET header: - description: 'Added as a part of security scheme: apikey' key: X-Api-Key value: code: 500 _postman_previewlanguage: json responseTime: null header: - key: Content-Type value: application/json name: Unexpected error _postman_previewtype: html body: |- { "message": "dolore Excepteur" } cookie: [] status: Internal Server Error id: db674465-8cec-4208-9724-42278ca9b83c id: d3779255-5293-4e58-9b65-8954936e1dca request: url: host: - https://api.postman.com raw: https://api.postman.com/spacecrafts/:spacecraftId variable: - description: (Required) The unique identifier of the spacecraft key: spacecraftId value: path: - spacecrafts - :spacecraftId method: GET header: - key: Accept value: application/json name: Read a spacecraft auth: apikey: - key: key value: X-Api-Key - key: value value: '{{apiKey}}' - key: in value: header type: apikey info: description: Buy or rent spacecrafts _postman_id: e726de58-f1b3-4edd-a8a7-2579dc799d39 schema: https://schema.postman.com/json/collection/v2.1.0/collection.json name: Generated variable: - value: / type: string id: 526a20ba-acfb-4549-a841-8edf2d24b929 key: baseUrl addApiCollectionResponse: value: id: 12345678-61867bcc-c4c1-11ed-afa1-0242ac120002 getApiCollection: value: item: - protocolProfileBehavior: disableBodyPruning: true response: - originalRequest: url: host: - https://api.postman.com raw: https://api.postman.com/spacecrafts/:spacecraftId variable: - description: (Required) The unique identifier of the spacecraft key: spacecraftId value: path: - spacecrafts - :spacecraftId method: GET header: - description: 'Added as a part of security scheme: apikey' key: X-Api-Key value: code: 200 _postman_previewlanguage: json responseTime: null header: - key: Content-Type value: application/json name: The spacecraft corresponding to the provided `spacecraftId` _postman_previewtype: html body: |- { "id": "", "name": "commodo", "type": "capsule", "description": "pariatur dolo" } cookie: [] status: OK id: 54467f6e-71d7-43d5-acc0-48f948e38528 - originalRequest: url: host: - https://api.postman.com raw: https://api.postman.com/spacecrafts/:spacecraftId variable: - description: (Required) The unique identifier of the spacecraft key: spacecraftId value: path: - spacecrafts - :spacecraftId method: GET header: - description: 'Added as a part of security scheme: apikey' key: X-Api-Key value: code: 404 _postman_previewlanguage: json responseTime: null header: - key: Content-Type value: application/json name: No spacecraft found for the provided `spacecraftId` _postman_previewtype: html body: |- { "message": "dolore Excepteur" } cookie: [] status: Not Found id: 1231609a-7a3d-444d-aa0c-579703e618f4 - originalRequest: url: host: - https://api.postman.com raw: https://api.postman.com/spacecrafts/:spacecraftId variable: - description: (Required) The unique identifier of the spacecraft key: spacecraftId value: path: - spacecrafts - :spacecraftId method: GET header: - description: 'Added as a part of security scheme: apikey' key: X-Api-Key value: code: 500 _postman_previewlanguage: json responseTime: null header: - key: Content-Type value: application/json name: Unexpected error _postman_previewtype: html body: |- { "message": "dolore Excepteur" } cookie: [] status: Internal Server Error id: db674465-8cec-4208-9724-42278ca9b83c id: d3779255-5293-4e58-9b65-8954936e1dca request: url: host: - https://api.postman.com raw: https://api.postman.com/spacecrafts/:spacecraftId variable: - description: (Required) The unique identifier of the spacecraft key: spacecraftId value: path: - spacecrafts - :spacecraftId method: GET header: - key: Accept value: application/json name: Read a spacecraft auth: apikey: - key: key value: X-Api-Key - key: value value: '{{apiKey}}' - key: in value: header type: apikey info: description: Buy or rent spacecrafts _postman_id: e726de58-f1b3-4edd-a8a7-2579dc799d39 schema: https://schema.postman.com/json/collection/v2.1.0/collection.json name: Generated variable: - value: / type: string id: 526a20ba-acfb-4549-a841-8edf2d24b929 key: baseUrl apiCollection400InvalidParam: value: type: invalidParamsError title: The specified parameter is in an invalid format detail: Parameter, collectionId is in an invalid format. apiVersion400ErrorInvalidParam: value: type: invalidParamsError title: The specified parameter is in an invalid format detail: Parameter, taskId is in an invalid format. api400ErrorVersionIdMissing: value: title: Invalid request body type: invalidParamError detail: Missing field "versionId" in the request body apiSchema400ErrorInvalidParams: value: type: invalidParamsError title: Could not create the resource detail: Schema already exists for this API apiSchema400ErrorNotLinked: value: type: invalidParamError title: Invalid param error detail: Schema is not linked to the API apiVersion400ErrorInstanceNotFound: value: error: name: instanceNotFoundError message: We could not find the API version you are looking for apiSchema422ErrorActionNotAllowed: value: type: actionNotAllowedError title: Action not allowed detail: This action is not allowed for git linked APIs apiVersion422ErrorStateInconsistent: value: type: APIStateInconsistent title: API state seems to be inconsistent. detail: Please perform a Git push from the Postman app to sync state between app and repository. gitLinkedApi422Error: value: type: actionNotAllowedError title: Action not allowed detail: This action is not allowed for Git linked APIs commentGet: value: data: - id: 46818 threadId: 12345 status: Open createdBy: 12345678 createdAt: '2024-01-18T12:00:54.000Z' updatedAt: '2024-01-18T12:00:54.000Z' body: This is also an example. - id: 46817 threadId: 67890 status: Resolved createdBy: 87654321 createdAt: '2024-01-18T11:48:01.000Z' updatedAt: '2024-01-18T11:48:01.000Z' body: Another example. - id: 46814 threadId: 23456 status: Open createdBy: 12345678 createdAt: '2024-01-18T11:30:40.000Z' updatedAt: '2024-01-18T11:30:40.000Z' body: This is an example. comment401Error: value: type: https://api.postman.com/problems/unauthorized title: Unauthorized detail: Unauthorized status: 401 comment403Error: value: type: https://api.postman.com/problems/forbidden title: Forbidden detail: Forbidden status: 403 comment404Error: value: type: https://api.postman.com/problems/not-found title: Not Found detail: Not Found status: 404 comment500Error: value: type: https://api.postman.com/problems/internal-server-error title: Internal Server Error detail: Internal Server Error status: 500 commentCreate: value: body: This is an example. commentCreateReply: value: body: This is an example. threadId: 12345 commentTagUser: value: body: This is an example. @alex-cruz tags: '@alex-cruz': type: user id: '87654321' commentCreated: value: data: id: 46814 threadId: 12345 status: Open createdBy: 12345678 createdAt: '2024-01-18T11:30:40.000Z' updatedAt: '2024-01-18T11:30:40.000Z' body: This is an example. commentCreatedTagUser: value: data: id: 46814 threadId: 12345 status: Open createdBy: 12345678 createdAt: '2024-01-18T11:30:40.000Z' updatedAt: '2024-01-18T11:30:40.000Z' body: This is an example. @alex-cruz commentUpdated: value: data: id: 46814 threadId: 12345 status: Open createdBy: 12345678 createdAt: '2024-01-18T11:30:40.000Z' updatedAt: '2024-01-18T11:30:40.000Z' body: This is an updated example. commentUpdatedTagUser: value: data: id: 46814 threadId: 12345 status: Open createdBy: 12345678 createdAt: '2024-01-18T11:30:40.000Z' updatedAt: '2024-01-18T11:30:40.000Z' body: This is an updated example. @alex-cruz syncCollectionWithSchemaResponse: value: taskId: 66ae9950-0869-4e65-96b0-1e0e47e771af createJsonSchema: value: type: openapi:3 files: - path: index.json content: |- { "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Sample API", "description": "Buy or rent spacecrafts" }, "paths": { "/spacecrafts/{spacecraftId}": { "parameters": [ { "name": "spacecraftId", "description": "The unique identifier of the spacecraft", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SpacecraftId" } } ], "get": { "summary": "Read a spacecraft", "responses": { "200": { "description": "The spacecraft corresponding to the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Spacecraft" } } } }, "404": { "description": "No spacecraft found for the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "#/components/schemas/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key" } } }, "security": [ { "ApiKey": [ ] } ] } createYamlSchema: value: type: openapi:3_1 files: - path: index.yaml content: | openapi: "3.1.0" info: version: "1.0.0" title: "Sample API" description: Buy or rent spacecrafts paths: /spacecrafts/{spacecraftId}: parameters: - name: spacecraftId description: The unique identifier of the spacecraft in: path required: true schema: $ref: "#/components/schemas/SpacecraftId" get: summary: Read a spacecraft responses: "200": description: The spacecraft corresponding to the provided `spacecraftId` content: application/json: schema: $ref: "#/components/schemas/Spacecraft" 404: description: No spacecraft found for the provided `spacecraftId` content: application/json: schema: $ref: "#/components/schemas/Error" 500: description: Unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" components: schemas: SpacecraftId: description: The unique identifier of a spacecraft type: string Spacecraft: type: object required: - id - name - type properties: id: $ref: "#/components/schemas/SpacecraftId" name: type: string type: type: string enum: - capsule - probe - satellite - spaceplane - station description: type: string Error: type: object required: - message properties: message: description: A human readable error message type: string securitySchemes: ApiKey: type: apiKey in: header name: X-Api-Key security: - ApiKey: [] createGraphQlSchema: value: type: graphql files: - path: posts.graphql content: "type Query {\r\n allPosts: [Post]\r\n allUsers: [User]\r\n postById(id: Int!): Post\r\n userById(id: Int!): User\r\n}\r\n\r\ntype Mutation {\r\n createPost(input: CreatePostInput!): CreatePostPayload\r\n createUser(input: CreateUserInput!): CreateUserPayload\r\n}\r\n\r\ntype Post {\r\n id: Int!\r\n title: String\r\n body: String\r\n createdDate: Datetime\r\n authorId: Int!\r\n userByAuthorId: User\r\n}\r\n\r\ntype User {\r\n id: Int!\r\n username: String\r\n createdDate: Datetime\r\n postsByAuthorId: [Post]\r\n}\r\n\r\ntype CreatePostPayload {\r\n clientMutationId: String\r\n post: Post\r\n userByAuthorId: User\r\n}\r\n\r\ninput CreatePostInput {\r\n clientMutationId: String\r\n post: PostInput!\r\n}\r\n\r\ninput PostInput {\r\n id: Int\r\n title: String\r\n body: String\r\n createdDate: Datetime\r\n authorId: Int!\r\n}\r\n\r\ntype CreateUserPayload {\r\n clientMutationId: String\r\n user: User\r\n}\r\n\r\ninput CreateUserInput {\r\n clientMutationId: String\r\n user: UserInput!\r\n}\r\n\r\ninput UserInput {\r\n id: Int\r\n username: String\r\n createdDate: Datetime\r\n}\r\n\r\nscalar Datetime\r\n" createProtoSchema: value: type: proto:2 files: - path: index.proto content: root: enabled: true createApiSchemaResponse: value: type: openapi:3 files: - createdBy: '12345678' path: index.json updatedBy: '12345678' updatedAt: '2024-07-18T13:17:30.000Z' root: enabled: true id: b4fc1bdc-6587-4f9b-95c9-f768146089b4 name: index.json createdAt: '2024-07-18T13:17:30.000Z' updatedAt: '2024-07-18T13:17:30.000Z' createdAt: '2024-07-18T13:17:30.000Z' createdBy: '12345678' updatedBy: '12345678' id: b4fc1bdc-6587-4f9b-95c9-f768146089b4 getApiSchema: value: createdAt: '2022-03-29T11:37:15Z' updatedAt: '2022-03-29T11:37:15Z' files: meta: nextPath: /apis/1fdbff7c-036b-4f8a-91bc-17bf3ae74fd2/schemas/cf98c187-17c1-455f-afbf-d4be51f12770/files?cursor=eyJzY2hlbWUiOiJwYXRoX2FzYyIsImRpcmVjdGlvblR5cGUiOiJuZXh0IiwicGl2b3QiOiJwYXRoIiwidmFsdWUiOiJkaXIvczEuanNvbiJ9 data: - createdBy: '12345678' path: dir/s1.json updatedBy: '12345678' updatedAt: '2023-03-16T19:11:24.000Z' createdAt: '2023-03-16T18:38:56.000Z' id: cf98c187-17c1-455f-afbf-d4be51f12770 name: s1.json getApiSchemaFiles: value: meta: nextCursor: eyJzY2hlbWUiOiJwYXRoX2FzYyIsImRpcmVjdGlvblR5cGUiOiJuZXh0IiwicGl2b3QiOiJwYXRoIiwidmFsdWUiOiJOZXdQZXQuanNvbiJ9 files: - id: e8a015e0-f472-4bb3-a523-57ce7c4583ed path: data-model/error.yaml name: error.yaml createdAt: '2022-03-29T11:37:15Z' updatedAt: '2022-03-29T11:37:15Z' createdBy: 12345678 updatedBy: 12345678 - id: e8a015e0-f472-4bb3-a523-57ce7c4583ef path: data-model/error2.yaml name: error2.yaml createdAt: '2022-03-29T11:37:15Z' updatedAt: '2022-03-29T11:37:15Z' createdBy: 12345678 updatedBy: 12345678 getApiSchemaFileContents: value: id: 0784657a-668d-4530-85c8-468becdb06fd name: Test.json path: common/Test.json content: |- openapi: '3.0.0' info: version: '1.0.0' title: 'Sample API' description: Buy or rent spacecrafts paths: /spacecrafts/{spacecraftId}: parameters: - name: spacecraftId description: The unique identifier of the spacecraft in: path required: true schema: $ref: '#/components/schemas/SpacecraftId' get: summary: Read a spacecraft responses: '200': description: The spacecraft corresponding to the provided `spacecraftId` content: application/json: schema: $ref: '#/components/schemas/Spacecraft' 404: description: No spacecraft found for the provided `spacecraftId` content: application/json: schema: $ref: '#/components/schemas/Error' 500: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: SpacecraftId: description: The unique identifier of a spacecraft type: string Spacecraft: type: object required: - id - names - type properties: id: $ref: '#/components/schemas/SpacecraftId' name: type: string type: type: string enum: - capsule - probe - satellite - spaceplane - station description: type: string Error: type: object required: - message properties: message: description: A human readable error message type: string securitySchemes: ApiKey: type: apiKey in: header name: X-Api-Key security: - ApiKey: [] createdAt: '2023-03-15T13:27:45.000Z' createdBy: '12345678' updatedAt: '2023-03-15T13:27:45.000Z' updatedBy: '12345678' updateJsonSchema: value: content: |- { "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Sample API", "description": "Buy or rent spacecrafts" }, "paths": { "/spacecrafts/{spacecraftId}": { "parameters": [ { "name": "spacecraftId", "description": "The unique identifier of the spacecraft", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SpacecraftId" } } ], "get": { "summary": "Read a spacecraft", "responses": { "200": { "description": "The spacecraft corresponding to the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Spacecraft" } } } }, "404": { "description": "No spacecraft found for the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "#/components/schemas/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key" } } }, "security": [ { "ApiKey": [ ] } ] } updateYamlSchema: value: content: | openapi: "3.1.0" info: version: "1.0.0" title: "Sample API" description: Buy or rent spacecrafts paths: /spacecrafts/{spacecraftId}: parameters: - name: spacecraftId description: The unique identifier of the spacecraft in: path required: true schema: $ref: "#/components/schemas/SpacecraftId" get: summary: Read a spacecraft responses: "200": description: The spacecraft corresponding to the provided `spacecraftId` content: application/json: schema: $ref: "#/components/schemas/Spacecraft" 404: description: No spacecraft found for the provided `spacecraftId` content: application/json: schema: $ref: "#/components/schemas/Error" 500: description: Unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" components: schemas: SpacecraftId: description: The unique identifier of a spacecraft type: string Spacecraft: type: object required: - id - name - type properties: id: $ref: "#/components/schemas/SpacecraftId" name: type: string type: type: string enum: - capsule - probe - satellite - spaceplane - station description: type: string Error: type: object required: - message properties: message: description: A human readable error message type: string securitySchemes: ApiKey: type: apiKey in: header name: X-Api-Key security: - ApiKey: [] updateGraphQlSchema: value: content: "type Query {\r\n allPosts: [Post]\r\n allUsers: [User]\r\n postById(id: Int!): Post\r\n userById(id: Int!): User\r\n}\r\n\r\ntype Mutation {\r\n createPost(input: CreatePostInput!): CreatePostPayload\r\n createUser(input: CreateUserInput!): CreateUserPayload\r\n}\r\n\r\ntype Post {\r\n id: Int!\r\n title: String\r\n body: String\r\n createdDate: Datetime\r\n authorId: Int!\r\n userByAuthorId: User\r\n}\r\n\r\ntype User {\r\n id: Int!\r\n username: String\r\n createdDate: Datetime\r\n postsByAuthorId: [Post]\r\n}\r\n\r\ntype CreatePostPayload {\r\n clientMutationId: String\r\n post: Post\r\n userByAuthorId: User\r\n}\r\n\r\ninput CreatePostInput {\r\n clientMutationId: String\r\n post: PostInput!\r\n}\r\n\r\ninput PostInput {\r\n id: Int\r\n title: String\r\n body: String\r\n createdDate: Datetime\r\n authorId: Int!\r\n}\r\n\r\ntype CreateUserPayload {\r\n clientMutationId: String\r\n user: User\r\n}\r\n\r\ninput CreateUserInput {\r\n clientMutationId: String\r\n user: UserInput!\r\n}\r\n\r\ninput UserInput {\r\n id: Int\r\n username: String\r\n createdDate: Datetime\r\n}\r\n\r\nscalar Datetime\r\n" updateProtoSchema: value: root: enabled: true createUpdateApiSchemaFileResponse: value: createdBy: '12345678' createdAt: '2024-07-18T13:47:39.000Z' root: enabled: true name: index.json path: index.json updatedBy: '12345678' id: 2fdc8ea1-d02e-4e50-989e-6fa28f42b995 updatedAt: '2024-07-18T13:48:28.000Z' getMigrationStatusSuccess: value: status: COMPLETED details: workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 getMigrationStatusFailure: value: status: FAILED details: reason: Moving to Spec Hub failed. Please try again or contact support. migrateApiToSpecHub400ErrorMigrationStatusInvalidFormat: value: error: name: invalidParamsError message: The specified parameter is in an invalid format details: param: apiId migrateApiToSpecHub401Error: value: detail: Unauthorized title: Unauthorized type: https://api.postman.com/problems/unauthorized instance: /apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/spec-migrations status: 401 apiSpec403ErrorForbidden: value: type: https://api.postman.com/problems/forbidden title: You are not permitted to perform the action. status: 403 detail: Please ensure that you have required permissions apiSpecSyncOptions403ErrorAuthenticationError: value: type: https://api.postman.com/problems/forbidden title: AuthenticationError status: 403 detail: Invalid API Key. Every request requires a valid API Key to be sent. instance: /specifications/73e15000-bc7a-4802-b80e-05fff18fd7f8/collections/12ece9e1-2abf-4edc-8e34-de66e74114d2 apiSpec403ErrorNoPermissions: value: type: forbiddenError title: You are not permitted to perform the action. detail: You do not have access to perform this operation. status: 403 migrateApiToSpecHubExistingWorkspace: value: workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 migrateApiToSpecHubNewWorkspace: value: workspaceInfo: name: API Workspace migrateGitConnectedApiToSpecHub: value: workspaceInfo: name: API Workspace gitInfo: path: /spaceships migrateApiToSpecHubResponseEmptyMigration: value: message: This API doesn't have any API Definition or Collection success: true migrateApiToSpecHubResponse: value: message: Moving to Spec Hub started successfully success: true migrateApiToSpecHub400ErrorRepoLinkedToAnotherWorkspace: value: error: title: Moving to Spec Hub not possible details: workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 message: The git repository is already linked to another workspace. Please reach out to Postman support for assistance. migrateApiToSpecHub400ErrorUnsupportedDefinitionType: value: error: title: Definition type not supported message: 'This API contains an unsupported definition type wsdl:1.0. Spec Hub supports: OAS3, OAS3.1, OAS2.0, AsyncAPI2.0, graphQl, gRPC.' migrateApiToSpecHub400ErrorInvalidPathParam: value: error: type: badRequest name: invalidGitInfoPath message: The provided path is invalid. It must be an absolute path starting with \, contain only alphanumeric characters, slashes, hyphens, underscores, and dots, and must not contain \..\ path traversal sequences. title: Invalid path parameter tagGetPut: value: tags: - slug: needs-review - slug: test-api tag401Error: value: type: https://api.postman.com/problems/unauthorized title: Unauthorized detail: The request lacks valid credentials. status: 401 tag401ErrorUnauthorized: value: type: https://api.postman.com/problems/unauthorized title: Unauthorized status: 401 tag403Error: value: type: https://api.postman.com/problems/forbidden title: Access Denied detail: The tags feature is only available to enterprise teams status: 403 tag404Error: value: type: https://api.postman.com/problems/not-found title: Resource Not Found detail: Slug 'needs-review' does not exist. status: 404 instance: /tags/needs-review/entities tag500Error: value: type: https://api.postman.com/problems/internal-server-error title: Something went wrong detail: Something went wrong while fetching entities having the provided slug. status: 500 instance: /tags/needs-review/entities tagUpdateTags: value: tags: - slug: needs-review tag400Error: value: title: Bad Request detail: body/tags/0/slug must NOT have more than 64 characters status: 400 getStatusOfAnAsyncApiTask: value: id: 66ae9950-0869-4e65-96b0-1e0e47e771af meta: url: https://api.postman.com/apis/5360b75f-447e-467c-9299-12fd6c92450d/collections/e726de58-f1b3-4edd-a8a7-2579dc799d39/sync model: collection action: update status: failed details: error: message: The API contains invalid schema createdAt: '2019-02-12 19:34:49' updatedAt: '2023-02-12 19:34:49' taskNotFound: value: detail: Parameter, taskId is in an invalid format. title: The specified parameter is in an invalid format type: invalidParamsError getApiVersions: value: versions: - createdAt: '2022-06-09T14:48:45.000Z' updatedAt: '2022-06-09T19:50:49.000Z' id: 07d940bf-40fc-4acd-a11e-be6769894af0 name: Release 2.0 releaseNotes: This is the second release of the Test API. - createdAt: '2022-06-09T14:48:45.000Z' updatedAt: '2022-06-09T19:50:49.000Z' id: 3563baaa-07a2-46ed-9fd2-0e8a3c5f7ec2 name: Release 1.0 releaseNotes: This is the first release of the Test API. For more information, read the documentation. meta: nextCursor: VGh1IE1hciAxNiAyMDIzIDE3OjIxOjUzIEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk= limit: 2 total: 1000 createGitUnlinkedVersionSchema: value: name: v1 releaseNotes: This is the first release. collections: - id: e8a015e0-f472-4bb3-a523-57ce7c4583ed schemas: - id: 18a015e0-f472-4bb3-a523-57ce7c458387 createGitLinkedVersion: value: name: v1 branch: develop releaseNotes: This is the first release. collections: - filePath: postman/collections/c1.json schemas: - directoryPath: postman/schema createGitLinkedVersionRootFile: value: name: v1 branch: develop releaseNotes: This is the first release. schemas: - directoryPath: /dir/index.yml collections: - filePath: postman/collections/c1.json createApiVersionResponse: value: createdAt: '2023-06-09T14:48:45.000Z' updatedAt: '2023-06-09T19:50:49.000Z' id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: v1 releaseNotes: This is the first release. getApiVersion: value: version: createdAt: '2022-06-09T14:48:45.000Z' updatedAt: '2022-06-09T19:50:49.000Z' id: 3563baaa-07a2-46ed-9fd2-0e8a3c5f7ec2 name: Release 1.0 releaseNotes: This is the first release. schemas: - id: 13a441a3-6109-4f78-86eb-e0144d0ff275 type: openapi:3 collections: - id: aeedb353-494b-4424-82cf-358aece2bd1c name: collection1 updateApiVersion: value: name: Release 1.5 releaseNotes: This is the first public release update. updateApiVersionResponse: value: createdAt: '2022-06-09T14:48:45.000Z' updatedAt: '2022-06-09T19:50:49.000Z' id: 8d7ba74e-2c36-4e36-a263-f3c0c9ae21d2 name: Release 1.5 releaseNotes: This is the first public release update. getAuditLogsSuccessfulResponse: value: trails: - id: 12 ip: 192.0.2.0 userAgent: PostmanRuntime/7.29.0 Postman/5.5.4 ChromeApp action: user.login_password_success timestamp: '2022-11-10T18:31:32.000Z' message: taylor-lee successfully logged in using the Postman password. data: actor: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 active: true user: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 team: name: Postman-Testing id: 125648 - id: 13 ip: 192.0.2.0 userAgent: null action: team.scim_add_member timestamp: '2022-11-10T17:19:03.000Z' message: Taylor Lee provisioned user Alex Cruz data: actor: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 active: true user: name: Alex Cruz username: alex.cruz email: alex.cruz@example.com id: 87654321 team: name: Test-API id: 1234 - id: 14 ip: null userAgent: null action: user.authaccount.linked timestamp: '2022-11-10T17:19:02.000Z' message: Taylor Lee created account linkage for user. data: actor: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 active: true user: name: Alex Cruz username: alex.cruz email: alex.cruz@example.com id: 87654321 team: name: Test-API id: 1234 variables: auth_type: okta auth_uid: 8f868a0353fd46cbadfe8a6ab3853b94 authaccount_uid: f97535389e8447ae8006b2795a2059e1 - id: 15 ip: 192.0.2.0 userAgent: null action: team.create_group timestamp: '2022-11-10T15:54:47.000Z' message: Taylor Lee created group Test-API. data: actor: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 active: true user: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 team: name: API-Testing id: 11 variables: groupId: '1234' groupName: Test-API groupVisibility: team nextCursor: 95427049 getAuditLogsFilterResponseByUserID: value: trails: - id: 12 ip: 192.0.2.0 userAgent: PostmanRuntime/7.29.0 Postman/5.5.4 ChromeApp action: user.login_password_success timestamp: '2022-11-10T18:31:32.000Z' message: taylor-lee successfully logged in using the Postman password. data: actor: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 active: true user: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 team: name: Postman-Testing id: 125648 - id: 13 ip: 192.0.2.0 userAgent: null action: team.scim_add_member timestamp: '2022-11-10T17:19:03.000Z' message: Taylor Lee provisioned user Alex Cruz data: actor: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 active: true user: name: Alex Cruz username: alex.cruz email: alex.cruz@example.com id: 87654321 team: name: Test-API id: 1234 - id: 14 ip: null userAgent: null action: user.authaccount.linked timestamp: '2022-11-10T17:19:02.000Z' message: Taylor Lee created account linkage for user. data: actor: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 active: true user: name: Alex Cruz username: alex.cruz email: alex.cruz@example.com id: 87654321 team: name: Test-API id: 1234 variables: auth_type: okta auth_uid: 8f868a0353fd46cbadfe8a6ab3853b94 authaccount_uid: f97535389e8447ae8006b2795a2059e1 - id: 15 ip: 192.0.2.0 userAgent: null action: team.create_group timestamp: '2022-11-10T15:54:47.000Z' message: Taylor Lee created group Test-API. data: actor: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 active: true user: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 team: name: API-Testing id: 11 variables: groupId: '1234' groupName: Test-API groupVisibility: team nextCursor: 95427049 getAuditLogsFilterResponseByAuditAction: value: trails: - id: 13 ip: 192.0.2.0 userAgent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/143.0.0.0 Safari/537.36 action: user.apikey_create timestamp: '2025-12-22T05:14:47.000Z' message: 'Taylor Lee created an API key with identifier: 6948d*****.' data: actor: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 active: true user: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 team: name: Billing API Team id: 123 variables: apiKey: 6948d***** - id: 14 ip: 192.0.2.0 userAgent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.0.0 Safari/537.36 action: user.apikey_create timestamp: '2025-11-17T11:03:45.000Z' message: 'Alex Cruz created an API key with identifier: 691b0*****.' data: actor: name: Alex Cruz username: supply-technologist-87654321 email: alex.cruz@example.com id: 1068007 active: true user: name: Alex Cruz username: supply-technologist-87654321 email: alex.cruz@example.com id: 1068007 team: name: Billing API Team id: 123 variables: apiKey: 691b0***** getAuditLogsFilterResponseByOrder: value: trails: - id: 12 ip: 192.0.2.0 userAgent: PostmanRuntime/7.29.0 Postman/5.5.4 ChromeApp action: user.login_password_success timestamp: '2022-11-10T18:31:32.000Z' message: taylor-lee successfully logged in using the Postman password. data: actor: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 active: true user: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 team: name: Postman-Testing id: 125648 - id: 13 ip: 192.0.2.0 userAgent: null action: team.scim_add_member timestamp: '2022-11-10T17:19:03.000Z' message: Taylor Lee provisioned user Alex Cruz data: actor: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 active: true user: name: Alex Cruz username: alex.cruz email: alex.cruz@example.com id: 87654321 team: name: Test-API id: 1234 - id: 14 ip: null userAgent: null action: user.authaccount.linked timestamp: '2022-11-10T17:19:02.000Z' message: Taylor Lee created account linkage for user. data: actor: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 active: true user: name: Alex Cruz username: alex.cruz email: alex.cruz@example.com id: 87654321 team: name: Test-API id: 1234 variables: auth_type: okta auth_uid: 8f868a0353fd46cbadfe8a6ab3853b94 authaccount_uid: f97535389e8447ae8006b2795a2059e1 - id: 15 ip: 192.0.2.0 userAgent: null action: team.create_group timestamp: '2022-11-10T15:54:47.000Z' message: Taylor Lee created group Test-API. data: actor: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 active: true user: name: Taylor Lee username: taylor.lee email: taylor.lee@example.com id: 12345678 team: name: API-Testing id: 11 variables: groupId: '1234' groupName: Test-API groupVisibility: team nextCursor: 95427049 auditLogs400ErrorInvalidAuditAction: value: error: name: InvalidAuditAction message: 'Invalid audit action format. Expected format: prefix.action_name (e.g., user.login).' rateLimit429ErrorTooManyRequests: value: type: https://api.postman.com/problems/too-many-requests title: Too Many Requests detail: You have exceeded your request limit status: 429 common429ErrorRateLimitExceeded: value: type: https://api.postman.com/problems/rate-limit-exceeded title: Too Many Requests status: 429 detail: Rate limit exceeded. Retry after the period indicated by the Retry-After header. getAuditLogEventActions: value: data: - code: team.invoice_paid name: Invoice Paid - code: team.scim_add_member name: Provisioned SCIM User - code: team.ai_consent.grant name: AI Team Consent Granted - code: team.add_group_member name: Added Member to User Group - code: user.username_update name: Updated Username - code: team.update_trial_activation_count name: Updated trial activation count for the team - code: team.send_invite name: Sent Team Invite - code: team.pro_domain_updated name: Updated Team Subdomain - code: team.update_user_roles name: Updated User Roles - code: user.group.create name: User Group Created - code: user.provided_consent_for_multi_team_enablement name: Provided consent for multi team enablement - code: team.reject_pending_access_request name: Rejected Team Join Request - code: user.authaccount.delinked name: User SSO Account Delinked - code: team.last_member_reinstated name: Team Last Member Reinstated - code: team.start_limited_duration_trial name: Start Limited Duration Trial - code: team.convert_domain_type name: Convert Domain Type - code: team.encryption_migration_started name: Encryption Started for existing data - code: team.end_limited_duration_trial name: End Limited Duration Trial - code: team.update_billing_email name: Updated Billing Email - code: team.change_default_card name: Changed Default Payment Method - code: team.update_operation_limits name: Updated operation limits for team - code: user.export_data name: Exported Postman Data - code: user.ai_consent.revoke name: AI User Consent Revoked - code: team.url_updated name: Updated Team Subdomain - code: user.mfa_rotate_recovery_codes name: 2FA Recovery Codes Rotated - code: user:disable_external_accounts_linkage name: Disabled External Accounts Linkage - code: team.change_default_payment_method name: Default payment method changed - code: user.apikey_revoke name: Revoked Postman API Key - code: team.marked_internal name: Organization Marked Internal - code: team.update_product name: Updated Product - code: team.add_domain name: Added Domain - code: user.login_google_success name: User Logged-In Using Google OAuth - code: user.disabled_guest_sharing_for_object name: Disabled guest sharing for object - code: team.cancellation_request name: Raised Cancellation Request For Team - code: team.suggest_invite name: Suggested Invite - code: team.scim_provisioning_enabled name: SCIM provisioning enabled - code: team.create_partnership name: Created Partnership - code: team.update_user_role name: Updated User Role - code: team.remove_group_manager name: Removed group manager - code: team.update_team_discovery name: Updated Team Discovery - code: user.revoke_one_by_id name: User Session Revoked - code: team.add_group_manager name: Added group manager - code: team.consume_payment_link name: Used Payment Link - code: team.prodomain_disabled name: Disabled Team Subdomain - code: user.apikey_create name: Created Postman API Key - code: team.migrate_product name: Migrated the product - code: team.secret_scanner_finding.unresolve name: Unresolved a Secret - code: team.customauth.rotate_certificate name: Rotated Custom Auth Scheme Certificates - code: user.invalidate_email_manual name: Invalidated User Email - code: team.scimkey_create name: Created SCIM Key - code: team.secret_scanner_finding.revoke name: Revoked a Secret - code: team.update_allowed_payment_method name: Updated Allowed Payment Method - code: team.decrease_size name: Decreased Team Size - code: team.apikey_creation_enabled name: Enabled Postman API Key Creation For Team - code: team.group_summary_updated name: Updated group summary - code: team.scim_deactivate_member name: Deactivated SCIM User - code: team.domain_verification name: Domain Verification - code: team.retry_invoice_success name: Successfully Retried Invoice - code: team.client_secret_scanner_disabled name: Local Secret Protection Disabled - code: team.start_pro name: Started Paid Team Subscription - code: team.update_instruction name: Updated Instruction - code: team.create_group name: Created User Group - code: team.scimkey_delete name: Deleted SCIM Key - code: team.moved_subscription name: Transferred Team Subscription - code: team.domain_capture_enable_team_management name: Enabled Domain Capture - code: team.remove_partnership_member name: Remove Partnership Member - code: user.login_password_success name: User Logged-In Using Password - code: user.user_details_update name: Updated User Details - code: user.download_export_data name: Downloaded Exported Postman Data - code: team.domain_capture_add_user name: Added User Using Domain Capture - code: team.organization_disabled name: Team Disabled - code: team.client_secret_scanner_enabled name: Local Secret Protection Enabled - code: team.client_secret_scanner_justified name: Local Secret Justification - code: team.trial_end name: Trial Ended For Team - code: user.validate_email name: Validated User Email - code: team.apikey_expiry_update name: Updated Postman API Keys expiry Settings For Team - code: team.reject_invite name: Rejected User Invite - code: team.domain_capture_disable_team_management name: Disabled Domain Capture - code: team.remove_member name: Team Member Removed - code: team.trial_start name: Started Trial For Team - code: team.apikey_auto_revoke_disabled name: Disbled Auto-revoke Exposed Postman API keys For Team - code: team.apikey_auto_revoked name: Auto-revoked Exposed API Key - code: team.ai_consent.revoke name: AI Team Consent Revoked - code: team.update_slots name: Updated Slots - code: user.username_password_update name: Updated Username or Password - code: user.create_personal_context_from_team name: Create Personal Context from Team Data - code: user.apikey_regenerate name: Regenerated Postman API Key - code: team.update_invoice_details name: Updated Invoice Details - code: user.vault_export_policy_update name: Vault Export Policy Updated - code: team.trial_expiry name: Team Trial Expired - code: team.secret_scanner_finding.create name: Detected a Secret - code: user.profile_change name: Updated User Profile - code: team.update_limited_duration_trial_period_end name: Updated Limited Duration Trial Period - code: team.add_credits name: Added Credits For Team - code: team.delete_payment_method name: Deleted a payment method - code: team.customauth.update name: Updated Custom Auth Scheme - code: team.customauth.create name: Created Custom Auth Scheme - code: team.custom_token.enable name: Enabled Custom Token - code: user.login_sso_success name: User Logged-In Using SSO - code: team.encryption_enabled name: Encryption Enabled - code: user.login_password_error name: User Login Failed - code: team.generate_payment_link name: Generated Payment Link - code: team.update_public_profile_visibility name: Updated Public Profile Visibility - code: user.create name: User Signed Up - code: team.update_true_up_enabled name: Updated Auto-flex Enabled - code: user.user_deleted name: Deleted User - code: team.update_public_profile_member_list_visibility name: Updated Team Public Profile - code: user.apikey_activate name: Activated Postman API Key - code: team.payment_collection_method_updated name: Renewal Payment Preference Changed - code: team.delete_operation_override name: Deleted operation override for team - code: team.apikey_creation_disabled name: Disabled Postman API Key Creation For Team - code: team.update_true_up_period_end name: Updated Auto-flex period end date - code: user.apikey_delete name: Deleted Postman API Key - code: team.customauth.remove name: Removed Custom Auth Scheme - code: user.ai_consent.grant name: AI User Consent Granted - code: team.change_plan name: Changed Team Plan - code: team.domain_capture_mark_verified name: Verified Domain For Domain Capture - code: team.custom_token.update_pattern name: Update Custom Token Regex - code: team.apikey_auto_revoke_enabled name: Enabled Auto-revoke Exposed Postman API keys For Team - code: user.password_create name: Create Password - code: team.added_giveget_referee_month name: Applied Referee Code - code: team.apikey_revoke_all name: Admin Revoked All Postman API Keys - code: team.annual_plan_renewal name: Annual Plan Renewed For Team - code: team.added_giveget_referer_month name: Applied Referer Code - code: team.expansion name: Expansion - code: team.scimkey_regenerate name: Regenerated SCIM Key - code: team.remove_group_role name: Removed Role From User Group - code: user.apikey_rename name: Renamed Postman API Key - code: user.vault_export name: Vault Exported - code: team.apikey_revoke_all_exposed name: Admin Revoked All Exposed Postman API Keys - code: team.add_group_role name: Added Role To User Group - code: team.consume_purchase_key name: Used Purchase Key For Team - code: user.vault_reset name: Vault Reset - code: team.delete_group name: Deleted User Group - code: team.update_domain_verification name: Domain Verification Status Updated - code: team.custom_token.update_name name: Update Custom Token Name - code: user.exposed_apikey_disable name: Exposed API Key Revoked - code: team.client_secret_scanner_default_policy_updated name: Local Secret Protection Default Policy Updated - code: team.add_partnership_member name: Add Partnership Member - code: team.invoice_generated name: Invoice Generated - code: team.scim_provisioning_disabled name: SCIM provisioning disabled - code: team.update_renewals_to_skip name: Updated Renewals To Skip - code: team.update_team_discovery_auto_join name: Updated Auto Join via Team Discovery - code: team.delete_card name: Deleted Payment Method - code: team.payment_method_added name: Payment method added - code: team.delete_partnership name: Deleted Partnership - code: team.encryption_disabled name: Encryption Disabled - code: team.scimkey_revoke name: Revoked SCIM Key - code: team.organization_enabled name: Team Enabled - code: team.update_trial_period_end name: Updated trial period end of team - code: team.approve_invite name: Approved User Invite - code: team.enterprise_enabled name: Enabled SSO For Team - code: team.update_monitoring_block_count name: Updated Monitoring Block Count - code: team.increase_size name: Increased Team Size - code: user.account_logout name: User Logged-out - code: user.mfa_reset name: 2FA Reset - code: team.upgrade_via_transfer name: Transferred Subscription - code: team.customauth.disable name: Disabled Custom Auth Scheme - code: user.sync_disable name: Disabled Sync For User - code: user.apikey_deactivate name: Deactivated API Key - code: team.update_owner name: Updated Team Owner - code: team.account_state_changed name: Account State Changed - code: team.custom_token.disable name: Disabled Custom Token - code: team.modify_future_plan name: Set Instructions For Next Billing Cycle - code: team.start_enterprise name: Started Enterprise Plan - code: team.client_secret_scanner_workspace_policy_updated name: Local Secret Protection Workspace Policy Updated - code: team.last_member_deactivated name: Team Last Member Deactivated - code: team.custom_token.delete name: Deleted Custom Token - code: team.approve_pending_access_request name: Approved Team Join Request - code: team.encryption_rekey_started name: Encryption Re-keying Started - code: team.customauth.enable name: Enabled Custom Auth Scheme - code: team.solution_membership_updated name: Updated Solution Membership - code: user.concurrent_session_limit_hit name: Concurrent Session Limit Breached - code: team.early_renewal name: Early Renewal - code: team.domain_capture_create_domain name: Added Domain For Domain Capture - code: team.update_account_slots name: Updated Account Slots - code: team.set_instruction name: Set Instruction - code: team.group_name_updated name: Updated group name - code: team.resource-rfa-auto-approve-setting-updated name: Updated team join approval - code: team.start_trial name: Started Team Trial - code: team.scim_remove_member name: De-provisioned SCIM User - code: team.invoice_cancelled name: Cancelled Invoice For Team - code: team.update_sales_channel name: Updated Sales Channel - code: team.update_true_up_period name: Updated Auto-flex Period - code: user.authaccount.linked name: User SSO Account Linked - code: user.login_oauth_success name: User Logged-In Using OAuth - code: team.encryption_migration_completed name: Encryption Completed for existing data - code: user.vault_register name: Vault Enabled - code: team.secret_scanner_finding.resolve name: Resolved a Secret - code: user.enabled_guest_sharing_for_object name: Enabled guest sharing for object - code: team.update_true_up_cycle_end_dates name: Updated custom true-up cycle end dates - code: team.start_free name: Started Free Plan - code: user.pro_dashboard_enabled name: Opted-in to Dashboard Beta - code: team.scimkey_activate name: Activated SCIM Key - code: user.consume_purchase_key name: Used Purchase Key To Activate Team - code: user.password_change name: Updated User Password - code: team.add_card name: Added Payment Method - code: team.domain_capture_delete_domain name: Deleted Domain For Domain Capture - code: user.mfa_enabled name: 2FA Enabled - code: team.add_member name: Added Team Member - code: team.cancel_plan name: Cancelled Team Plan - code: user.password_reset name: Reset User Password - code: team.prodomain_enabled name: Enabled Team Subdomain - code: team.activation_reset name: Reset Activation - code: team.upgrade_to_paid name: Upgraded to Paid Team Plan - code: team.enterprise_disabled name: Disabled SSO For Team - code: team.execute_instruction name: Executed Instruction - code: user.provided_consent_for_merging_personal_context name: Provided consent for merging personal context - code: team.custom_token.create name: Added Custom Token Alert - code: user.mfa_disabled name: 2FA Disabled - code: team.update_billed_operation_overage name: Updated Billed Operation Allow Overage - code: team.auto_renewal_consent_updated name: Auto Renewal Consent Updated - code: team.encryption_key_inaccessible name: Encryption Key Inaccessible - code: team.last_member_cleaned_up name: Team Last Member Cleaned Up - code: team.install_click name: Install App - code: team.remove_group_member name: Removed User Group Member - code: user.pro_dashboard_disabled name: Opted-out of Dashboard Beta - code: team.update_group name: Updated User Group - code: team.delete_payment_link name: Deleted Payment Link - code: team.delete_domain name: Deleted Domain - code: user.group.update name: User Group Updated - code: team.encryption_key_updated name: Encryption Key Updated - code: team.name_updated name: Updated Team Name - code: team.marked_non_internal name: Organization Marked Non-internal - code: team.apikey_revoke name: Admin Revoked Postman API Key(s) - code: team.cancel_invite name: Cancelled Team Invite - code: team.scim_activate_member name: Activated SCIM User - code: team.pricing_update name: Plan Migrated - code: team.encryption_rekey_completed name: Encryption Re-keying Completed - code: team.update_billed_operation name: Updated Add-on - code: user.revoke_multiple_sessions name: Revoked Multiple User Sessions auditLogs403ErrorForbidden: value: error: name: ForbiddenRequest message: You do not have permissions to view audit actions getCollectionAccessKeys: value: data: - id: Njg5OjU3MDQ1NjYtYmQxZDU3NzktMWVkNS00ZDhjLWI0ZmQtZWRhOGY2Mzg1NTY0 token: PMAT-**********************43BR status: ACTIVE teamId: 123 userId: 12345678 collectionId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 expiresAfter: '2024-06-11T13:21:11.000Z' lastUsedAt: '' createdAt: '2024-04-12T13:21:11.000Z' updatedAt: '2024-04-09T11:00:53.000Z' - id: K7yJPzQ18BC7Snm09PXL12RMmnq57hQorFJW8JnCKhQ11JmNQiTlgXnQ1p93jGYN token: PMAT-**********************51FZ status: ACTIVE teamId: 123 userId: 56781234 collectionId: 56781234-68e5e7ac-c134-45f4-9770-40e72f3fc474 expiresAfter: '2024-06-11T13:21:11.000Z' lastUsedAt: '2024-04-29T08:24:23.000Z' createdAt: '2024-04-22T10:11:00.000Z' updatedAt: '2024-04-22T10:11:00.000Z' meta: nextCursor: b2Zmc2V0PTEwJmxpbWl0PTEw prevCursor: '' common400ErrorResponse: value: type: https://api.postman.com/problems/bad-request title: Bad Request detail: Bad Request status: 400 common400Error: value: type: badRequest title: Invalid request detail: Missing parameter, workspaceId common400ErrorRequestBodyMissing: value: type: https://api.postman.com/problems/bad-request title: Bad Request status: 400 detail: Request body is required common400ErrorInvalidCursor: value: type: https://api.postman.com/problems/bad-request title: Malformed request detail: Invalid cursor status: 400 paramMissing400ErrorName: value: error: name: paramMissingError message: Parameter is missing in the request. details: param: - name paramMissing400ErrorCollection: value: error: name: paramMissingError message: Parameter is missing in the request. details: param: - collection paramMissing400ErrorServerResponse: value: error: name: paramMissingError message: Parameter is missing in the request. details: param: - serverResponse paramMissing400ErrorResponseStatusCode: value: error: name: paramMissingError message: Parameter is missing in the request. details: param: - statusCode cakNotFound404Error: value: type: https://api.postman.com/problems/not-found title: Not Found status: 404 detail: The key was not found asyncCollectionForkMerge: value: strategy: default source: 12345678-5a027c05-056b-49f5-ac9d-37c29f2d91c3 destination: 12345678-b04fa319-3e7e-4fa3-b6a2-f5b29ad67583 asyncCollectionForkMergeUpdateSource: value: strategy: updateSourceWithDestination source: 12345678-5a027c05-056b-49f5-ac9d-37c29f2d91c3 destination: 12345678-b04fa319-3e7e-4fa3-b6a2-f5b29ad67583 asyncCollectionForkMergeDeleteSource: value: strategy: deleteSource source: 12345678-5a027c05-056b-49f5-ac9d-37c29f2d91c3 destination: 12345678-b04fa319-3e7e-4fa3-b6a2-f5b29ad67583 asyncMergePullCollectionForkSuccessfulResponse: value: task: id: pm~vc:merge-workflow~12345678-4824989b-cd77-4e2f-856c-1ff2a3e9aaca status: in-progress collectionForks400ErrorMalformedRequest: value: type: https://api.postman.com/problems/bad-request title: Malformed request status: 400 detail: Some validation errors occurred collectionForks403ErrorForbidden: value: type: https://api.postman.com/problems/forbidden title: Forbidden detail: You need Editor role on the destination entity and Viewer role on the source entity to merge changes. Additionally, you may also need Editor role on the source entity to update or delete while merging. status: 403 common403ErrorNotEnoughPermissions: value: type: https://api.postman.com/problems/forbidden title: Forbidden status: 403 detail: You do not have enough permissions to perform this action. asyncMergePullCollectionTaskStatusSuccess: value: id: pm~vc:merge-workflow~12345678-5a027c05-056b-49f5-ac9d-37c29f2d91c3 status: successful asyncMergePullCollectionTaskStatusInProgress: value: id: pm~vc:merge-workflow~12345678-5a027c05-056b-49f5-ac9d-37c29f2d91c3 status: in-progress asyncMergePullCollectionTaskStatusFailed: value: id: pm~vc:merge-workflow~12345678-5a027c05-056b-49f5-ac9d-37c29f2d91c3 status: failed details: error: message: All conflicts have not be resolved collectionForks404ErrorTaskNotFound: value: type: https://api.postman.com/problems/not-found title: Task not found detail: 'Workflow :: pm~vc:merge-workflow~12345678-5a027c05-056b-49f5-ac9d-37c29f2d91c3 not found' status: 404 getCollectionsSuccessfulResponse: value: collections: - id: dac5eac9-148d-a32e-b76b-3edee9da28f7 name: Cloud API owner: '12345678' createdAt: '2022-04-12T10:29:46.000Z' updatedAt: '2022-04-12T10:29:56.000Z' uid: 12345678-dac5eac9-148d-a32e-b76b-3edee9da28f7 isPublic: true - id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection owner: '12345678' createdAt: '2022-01-13T10:21:46.000Z' updatedAt: '2022-02-12T11:29:56.000Z' uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 isPublic: false fork: label: Test Fork createdAt: '2022-06-16T19:51:44.069Z' from: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 - id: f695cab7-6878-eb55-7943-ad88e1ccfd65 name: Postman Echo owner: '12345678' createdAt: '2021-04-11T09:18:26.000Z' updatedAt: '2022-05-01T15:29:32.000Z' uid: 12345678-f695cab7-6878-eb55-7943-ad88e1ccfd65 isPublic: true meta: total: 30 offset: 0 limit: 3 getCollectionsFilterByName: value: collections: - id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection owner: '12345678' createdAt: '2022-01-13T10:21:46.000Z' updatedAt: '2022-02-12T11:29:56.000Z' uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 isPublic: false fork: label: Test Fork createdAt: '2022-06-16T19:51:44.069Z' from: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 getCollectionsFilterByWorkspace: value: collections: - id: dac5eac9-148d-a32e-b76b-3edee9da28f7 name: Cloud API owner: '12345678' createdAt: '2022-04-12T10:29:46.000Z' updatedAt: '2022-04-12T10:29:56.000Z' uid: 12345678-dac5eac9-148d-a32e-b76b-3edee9da28f7 isPublic: true getCollectionsInvalidWorkspace: value: collections: [] createCollection: value: collection: info: name: Test Collection description: This collection makes a request to the Postman Echo service to get a list of request headers sent by an HTTP client. schema: https://schema.postman.com/json/collection/v2.1.0/collection.json variable: - key: userId value: '12345678' disabled: true description: The user's ID. item: - name: Test GET Response event: - listen: test script: id: 7d2334fc-a84a-4c3d-b26c-7529afa4c0ae exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' type: text/javascript request: url: https://echo.postman.com/headers method: GET header: - key: Content-Type value: application/json createCollectionCreateCollection: value: collection: id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 collection400ErrorInstanceFoundBadRequest: value: error: name: instanceFoundError message: The specified item already exists. details: item: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 getCollectionsForkedByUserSuccessfulResponse: value: data: - forkName: Collection Fork forkId: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f sourceId: 87654321-bd46b634-b347-44d4-aa23-8c71ff4ecc4d createdAt: '2023-11-16T09:18:17.000Z' - forkName: Test Fork forkId: 12345678-38j9f1ad-2ee3-7890-dv5h-7742d82e2e1f sourceId: 87654321-bd46b634-b347-44d4-aa23-8c71ff4ecc4d createdAt: '2023-11-16T09:16:15.000Z' meta: total: 2 nextCursor: null inaccessibleFork: 0 getCollectionsForkedByUserResponseWithCursor: value: data: - forkName: Collection Fork forkId: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f sourceId: 87654321-bd46b634-b347-44d4-aa23-8c71ff4ecc4d createdAt: '2023-11-16T09:18:17.000Z' - forkName: Test Fork forkId: 12345678-38j9f1ad-2ee3-7890-dv5h-7742d82e2e1f sourceId: 87654321-bd46b634-b347-44d4-aa23-8c71ff4ecc4d createdAt: '2023-11-16T09:16:15.000Z' meta: total: 2 nextCursor: null inaccessibleFork: 0 getCollectionsForkedByUserResponseWithDirection: value: data: - forkName: Collection Fork forkId: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f sourceId: 87654321-bd46b634-b347-44d4-aa23-8c71ff4ecc4d createdAt: '2023-11-15T08:12:27.000Z' - forkName: Test Fork forkId: 12345678-38j9f1ad-2ee3-7890-dv5h-7742d82e2e1f sourceId: 87654321-bd46b634-b347-44d4-aa23-8c71ff4ecc4d createdAt: '2023-11-16T09:16:15.000Z' meta: total: 2 nextCursor: null inaccessibleFork: 0 getCollectionsForkedByUserResponseWithLimit: value: data: - forkName: Collection Fork forkId: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f sourceId: 87654321-bd46b634-b347-44d4-aa23-8c71ff4ecc4d createdAt: '2023-11-15T08:12:27.000Z' - forkName: Test Fork forkId: 12345678-38j9f1ad-2ee3-7890-dv5h-7742d82e2e1f sourceId: 87654321-bd46b634-b347-44d4-aa23-8c71ff4ecc4d createdAt: '2023-11-16T09:16:15.000Z' - forkName: My Fork forkId: 12345678-667df1ad-2gnm-7890-b678-7742d82e2e1f sourceId: 87654321-8c082f7b-6c1d-4110-9c44-ebe3353ba4e9 createdAt: '2023-10-03T10:00:07.000Z' - forkName: Testing forkId: 12345678-667df1ad-2ee3-ifb0-b678-7742d82e2e1f sourceId: 87654321-5995bdd5-3935-4789-955f-1d5507d602ab createdAt: '2023-12-18T00:02:25.000Z' - forkName: Example Fork forkId: 12345678-9af28c4f-2974-40c7-a834-e1a2a18cba8f sourceId: 87654321-5995bdd5-3935-4789-955f-1d5507d602ab createdAt: '2023-12-29T02:28:11.000Z' meta: total: 10 nextCursor: eyJpZCI6MzMyNzksImZvcmtzQWZ0ZXIiOjIwfQ== inaccessibleFork: 0 fork400ErrorNoUserFound: value: error: name: badRequest message: No Postman User found for given filters createCollectionFork: value: label: Test Fork createCollectionForkSuccessfulResponse: value: collection: id: 09547fef-a9a5-4e00-998b-aa563e8db69a name: Test Collection fork: label: Test Fork createdAt: '2022-06-16T19:51:44.069Z' from: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 uid: 12345678-09547fef-a9a5-4e00-998b-aa563e8db69a instanceNotFoundCollectionNotFound: value: error: name: instanceNotFoundError message: The specified item does not exist. details: item: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 pullCollectionChangesNotFound: value: error: name: notFoundError message: Fork not found. mergeCollectionFork: value: strategy: deleteSource source: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 destination: 12345678-09547fef-a9a5-4e00-998b-aa563e8db69a mergeCollectionForkResponse: value: collection: id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 getCollectionSuccessfulResponse: value: collection: info: _postman_id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection description: This is a test. schema: https://schema.getpostman.com/json/collection/v2.1.0/collection.json updatedAt: '2023-10-09T18:34:58.000Z' createdAt: '2023-10-09T18:34:58.000Z' lastUpdatedBy: '12345678' uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 item: - name: Folder 1 item: - name: ID item: - name: Test D event: - listen: prerequest script: exec: - pm.sendRequest("https://postman-echo.com/get", function (err, response) { - ' console.log(response.json());' - '});' type: text/javascript - listen: test script: exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' type: text/javascript id: c616506e-0676-4d79-88a7-c273b70e9cea protocolProfileBehavior: disableBodyPruning: true request: auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: api-key type: string method: GET header: [] url: raw: https://postman-echo.com/get?id=12345678 protocol: https host: - postman-echo - com path: - get query: - key: id value: '12345678' description: Optional. The user's ID. description: This is an example GET request. response: - id: d20b9562-9c85-4f25-bb2d-cfacf7dd85d1 name: Successful Response originalRequest: method: GET header: - key: Content-Type name: Content-Type value: application/json type: text url: raw: https://postman-echo.com/get?id=1234 protocol: https host: - postman-echo - com path: - get query: - key: id value: '1234' description: Optional. The user's ID. status: OK code: 200 _postman_previewlanguage: json header: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookie: [] responseTime: null body: |- { "id": "1234", "user": "test-user", "firstName": "Test", "lastName": "User" } createdAt: '2023-08-22T12:52:01.000Z' updatedAt: '2023-09-13T14:31:25.000Z' uid: 12345678-d20b9562-9c85-4f25-bb2d-cfacf7dd85d1 createdAt: '2023-08-22T12:52:01.000Z' updatedAt: '2023-09-13T14:31:25.000Z' uid: 12345678-c616506e-0676-4d79-88a7-c273b70e9cea - name: Test E id: bf6fd735-125e-486b-b7fb-9f0ae4a0bbc5 protocolProfileBehavior: disableBodyPruning: true request: auth: type: bearer bearer: - key: token value: TEST type: string method: PATCH header: [] body: mode: raw raw: |- { "username": "test-user", "firstName": "Test", "lastName": "User" } options: raw: language: json url: raw: https://postman-echo.com/get?id=12345678 protocol: https host: - postman-echo - com path: - get query: - key: id value: '12345678' description: Optional. The user's ID. description: This is an example GET request. response: - id: 86447cb0-aeac-4371-a22f-9f6067fc4dd0 name: Successful Response originalRequest: method: GET header: - key: Content-Type name: Content-Type value: application/json type: text body: mode: raw raw: |- { "firstName": "Test", "lastName": "User" } options: raw: language: json url: raw: https://postman-echo.com/get?id=1234 protocol: https host: - postman-echo - com path: - get query: - key: id value: '1234' description: Optional. The user's ID. status: OK code: 200 _postman_previewlanguage: json header: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookie: [] responseTime: null body: |- { "id": "1234", "user": "test-user" } createdAt: '2023-09-13T14:05:22.000Z' updatedAt: '2023-09-13T14:13:21.000Z' uid: 12345678-86447cb0-aeac-4371-a22f-9f6067fc4dd0 createdAt: '2023-09-13T14:05:22.000Z' updatedAt: '2023-09-13T14:14:41.000Z' uid: 12345678-bf6fd735-125e-486b-b7fb-9f0ae4a0bbc5 id: a7046e3e-fb60-44fc-8e32-a4578b854628 auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: api-key type: string event: - listen: prerequest script: type: text/javascript exec: - pm.sendRequest("https://postman-echo.com/get", function (err, response) { - ' console.log(response.json());' - '});' - listen: test script: type: text/javascript exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' createdAt: '2023-09-12T15:46:34.000Z' updatedAt: '2023-09-13T14:05:22.000Z' uid: 12345678-a7046e3e-fb60-44fc-8e32-a4578b854628 - name: Test A event: - listen: test script: exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' type: text/javascript - listen: prerequest script: exec: - pm.sendRequest("https://postman-echo.com/get", function (err, response) { - ' console.log(response.json());' - '});' type: text/javascript id: bb4a826b-1654-4f24-9ab1-d00e4fc2d743 protocolProfileBehavior: disableBodyPruning: true request: auth: type: bearer bearer: - key: token value: TEST type: string method: GET header: - key: Accept value: application/vnd.example.v1+json type: text body: mode: raw raw: '' options: raw: language: json url: raw: http://api.getpostman.com/v1/request?id=12345678 protocol: http host: - api - getpostman - com path: - v1 - request query: - key: id value: '12345678' description: The API's ID. description: This is a test API. response: - id: 5f297469-80d7-4847-a3e2-f596f2e717d8 name: Successful Response originalRequest: method: POST header: - key: Host value: postman-echo.com - key: user-agent value: curl/7.88.1 - key: accept value: '*/*' - key: content-type value: application/json - key: content-length value: '22' body: mode: raw raw: |- { "field": "Value" } options: raw: language: json url: raw: https://postman-echo.com/post protocol: https host: - postman-echo - com path: - post status: OK code: 200 _postman_previewlanguage: json header: - key: date value: Thu, 07 Sep 2023 12:41:59 GMT - key: content-type value: application/json; charset=utf-8 - key: content-length value: '468' - key: etag value: W/"1d4-JuAIw8ssoFCtGzk/UwITxaiSbrc" - key: set-cookie value: sails.sid=s%3A6p_NXpI3OZeGE35bI6i5Uq3XgHHxcsdJ.dQVpBE%2BJ9wHWainkqe6F6dkdv7UKoshSZY7sdZ5sbzo; Path=/ HttpOnly cookie: [] responseTime: null body: | { "args": {}, "data": { "field": "Value" }, "files": {}, "form": {}, "headers": { "x-forwarded-proto": "https", "x-forwarded-port": "443", "host": "postman-echo.com", "x-amzn-trace-id": "Root=1-64f9c517-36db304817c774d740619baa", "content-length": "22", "user-agent": "curl/7.88.1", "accept": "*/*", "content-type": "application/json" }, "json": { "field": "Value" }, "url": "https://postman-echo.com/post" } createdAt: '2023-09-12T18:34:27.000Z' updatedAt: '2023-09-13T14:04:37.000Z' uid: 12345678-5f297469-80d7-4847-a3e2-f596f2e717d8 - id: 789df3cf-9362-40f7-a69e-4adde47d2bc8 name: Not Found originalRequest: method: GET header: - key: Accept value: application/vnd.example.v1+json type: text body: mode: raw raw: '' options: raw: language: json url: raw: http://api.getpostman.com/v1/request?id=test-api protocol: http host: - api - getpostman - com path: - v1 - request query: - key: id value: test-api status: Not Found code: 404 _postman_previewlanguage: json header: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookie: [] responseTime: null body: |- { "title": "Not Found", "detail": "Requested API does not exist", "type": "about:blank" } createdAt: '2023-08-22T12:53:12.000Z' updatedAt: '2023-09-13T14:04:32.000Z' uid: 12345678-789df3cf-9362-40f7-a69e-4adde47d2bc8 createdAt: '2022-10-05T13:09:24.000Z' updatedAt: '2025-04-25T17:29:16.000Z' uid: 12345678-bb4a826b-1654-4f24-9ab1-d00e4fc2d743 - name: Test B id: 3e2b5890-8fb9-4a73-bf7b-f0a161502513 protocolProfileBehavior: disableBodyPruning: true request: method: PUT header: [] body: mode: raw raw: |- { "name": "Test", "description": "This is a test." } options: raw: language: json url: raw: http://api.getpostman.com/v1/request protocol: http host: - api - getpostman - com path: - v1 - request response: - id: c7ffac80-0ab7-45da-a966-10bf469936db name: Test B originalRequest: method: PUT header: - key: Content-Type name: Content-Type value: application/json type: text body: mode: raw raw: |- { "firstName": "Test", "lastName": "User" } options: raw: language: json url: raw: http://api.getpostman.com/v1/request protocol: http host: - api - getpostman - com path: - v1 - request status: OK code: 200 _postman_previewlanguage: json header: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookie: [] responseTime: null body: |- { "id": "1234", "user": "test-user" } createdAt: '2023-09-12T15:20:20.000Z' updatedAt: '2023-09-13T14:13:44.000Z' uid: 12345678-c7ffac80-0ab7-45da-a966-10bf469936db createdAt: '2022-10-05T13:16:49.000Z' updatedAt: '2023-09-13T14:08:04.000Z' uid: 12345678-3e2b5890-8fb9-4a73-bf7b-f0a161502513 - name: Test C event: - listen: test script: exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' type: text/javascript - listen: prerequest script: exec: - '' type: text/javascript id: 98518f83-1da1-4d27-8253-432cc923dbae protocolProfileBehavior: disableBodyPruning: true request: auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: api-key type: string method: POST header: [] body: mode: raw raw: |- { "name": "Test API", "description": "This is a test API." } options: raw: language: json url: raw: https://postman-echo.com/post protocol: https host: - postman-echo - com path: - post response: - id: bb3cb97c-619e-4c81-9a14-139efe81816c name: Successful Response originalRequest: method: POST header: [] body: mode: raw raw: |- { "name": "Test API", "description": "This is a test API." } options: raw: language: json url: raw: https://postman-echo.com/post protocol: https host: - postman-echo - com path: - post _postman_previewlanguage: json header: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookie: [] responseTime: null body: |- { "id": "test-api", "name": "Test API", "description": "This is a test API.", "is_public": false, "created_at": "2022-01-28T11:50:56.000Z", "updated_at": "2022-01-28T11:50:56.000Z", "performance": { "collection": "123e4567-e89b-12d3-a456-556642440000", "environment": "123e4567-e89b-12d3-a456-556642440000" } } createdAt: '2023-09-12T15:21:55.000Z' updatedAt: '2023-09-13T14:33:26.000Z' uid: 12345678-bb3cb97c-619e-4c81-9a14-139efe81816c createdAt: '2023-09-07T14:03:52.000Z' updatedAt: '2023-09-13T14:26:58.000Z' uid: 12345678-98518f83-1da1-4d27-8253-432cc923dbae id: c9a0e43c-6078-4fa0-8cfc-d4dc9e889817 description: This is a test folder. auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: x-api-key type: string event: - listen: prerequest script: type: text/javascript exec: - pm.variables.get("variable_key"); - listen: test script: type: text/javascript exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' createdAt: '2022-10-05T13:09:28.000Z' updatedAt: '2023-09-13T14:32:34.000Z' uid: 12345678-c9a0e43c-6078-4fa0-8cfc-d4dc9e889817 - name: Folder 3 item: - name: ID item: - name: Request 3-A id: a22f41d5-32bf-4830-8731-10ad18e88874 protocolProfileBehavior: disableBodyPruning: true request: method: GET header: [] body: mode: raw raw: '' options: raw: language: json url: raw: '' response: [] createdAt: '2023-09-14T12:44:28.000Z' updatedAt: '2023-09-15T16:25:21.000Z' uid: 12345678-a22f41d5-32bf-4830-8731-10ad18e88874 id: 07f106de-776e-4fd8-9fc1-dc72e4a06a00 description: Test folder user ID. createdAt: '2023-09-13T21:54:44.000Z' updatedAt: '2023-09-15T16:26:42.000Z' uid: 12345678-07f106de-776e-4fd8-9fc1-dc72e4a06a00 - name: User item: - name: New Request id: 69e1ed6c-9d7b-41cd-aff7-69a468cf8252 protocolProfileBehavior: disableBodyPruning: true request: method: POST header: [] url: raw: '' response: [] createdAt: '2023-09-14T14:02:27.000Z' updatedAt: '2023-09-14T14:02:59.000Z' uid: 12345678-69e1ed6c-9d7b-41cd-aff7-69a468cf8252 - name: New Request id: 8b50cfc3-6af3-446e-a607-8d05e38e1ce9 protocolProfileBehavior: disableBodyPruning: true request: method: GET header: [] url: raw: '' response: [] createdAt: '2023-09-14T14:02:49.000Z' updatedAt: '2023-09-14T14:02:49.000Z' uid: 12345678-8b50cfc3-6af3-446e-a607-8d05e38e1ce9 id: 2c9de017-885f-4c1e-99bf-d10cd870fb0b description: Test folder for user information. createdAt: '2023-09-13T21:56:35.000Z' updatedAt: '2023-09-15T16:26:54.000Z' uid: 12345678-2c9de017-885f-4c1e-99bf-d10cd870fb0b - name: Test A id: 8b29623b-9c9c-4fed-ab9e-85f64524977b protocolProfileBehavior: disableBodyPruning: true request: method: GET header: [] url: raw: http://api.getpostman.com/v1/request protocol: http host: - api - getpostman - com path: - v1 - request response: [] createdAt: '2022-11-18T15:42:45.000Z' updatedAt: '2023-09-13T14:07:08.000Z' uid: 12345678-8b29623b-9c9c-4fed-ab9e-85f64524977b id: 7d1ea228-82fc-4887-833a-caf88d3182d5 description: This is a test folder. auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: x-api-key type: string event: - listen: prerequest script: type: text/javascript exec: - pm.sendRequest("https://postman-echo.com/get", function (err, response) { - ' console.log(response.json());' - '});' - listen: test script: type: text/javascript exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' createdAt: '2022-10-05T13:09:34.000Z' updatedAt: '2023-09-15T18:22:13.000Z' uid: 12345678-7d1ea228-82fc-4887-833a-caf88d3182d5 - name: Test F id: ff460862-473c-41b8-8be4-a493041c3351 protocolProfileBehavior: disableBodyPruning: true request: method: POST header: [] url: raw: '' response: [] createdAt: '2023-08-22T12:51:45.000Z' updatedAt: '2025-05-29T16:04:09.000Z' uid: 12345678-ff460862-473c-41b8-8be4-a493041c3351 auth: type: apikey apikey: - key: value value: abc123 type: string - key: key value: x-api-key type: string event: - listen: prerequest script: id: cc22c328-3dcc-46c1-a357-7e2f72f54cf6 type: text/javascript packages: {} exec: - try { - ' const response = await pm.sendRequest({' - ' url: "https://postman-echo.com/get",' - ' method: "GET"' - ' });' - '' - ' console.log(response.json());' - '} catch (err) {' - ' console.error(err);' - '}' - listen: test script: id: 5db243ea-5022-4d08-a620-b8fb9d561af5 type: text/javascript packages: {} exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' variable: - key: userId value: '12345678' disabled: true description: The user's ID. getCollectionForkedCollectionResponse: value: collection: info: _postman_id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection description: This is a test. fork: label: Collection fork createdAt: '2024-07-17T13:12:43.000Z' from: 87654321-c8142d52-f97d-46a7-bc77-52bb99713o1n schema: https://schema.getpostman.com/json/collection/v2.1.0/collection.json updatedAt: '2023-10-09T18:34:58.000Z' createdAt: '2023-10-09T18:34:58.000Z' uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 lastUpdatedBy: '12345678' item: - name: Folder 1 item: - name: ID item: - name: Test D event: - listen: prerequest script: exec: - pm.sendRequest("https://postman-echo.com/get", function (err, response) { - ' console.log(response.json());' - '});' type: text/javascript - listen: test script: exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' type: text/javascript id: c616506e-0676-4d79-88a7-c273b70e9cea protocolProfileBehavior: disableBodyPruning: true request: auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: api-key type: string method: GET header: [] url: raw: https://postman-echo.com/get?id=12345678 protocol: https host: - postman-echo - com path: - get query: - key: id value: '12345678' description: Optional. The user's ID. description: This is an example GET request. response: - id: d20b9562-9c85-4f25-bb2d-cfacf7dd85d1 name: Successful Response originalRequest: method: GET header: - key: Content-Type name: Content-Type value: application/json type: text url: raw: https://postman-echo.com/get?id=1234 protocol: https host: - postman-echo - com path: - get query: - key: id value: '1234' description: Optional. The user's ID. status: OK code: 200 _postman_previewlanguage: json header: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookie: [] responseTime: null body: |- { "id": "1234", "user": "test-user", "firstName": "Test", "lastName": "User" } createdAt: '2023-09-07T14:39:52.000Z' updatedAt: '2023-09-13T14:13:08.000Z' uid: 12345678-d20b9562-9c85-4f25-bb2d-cfacf7dd85d1 createdAt: '2023-08-22T12:52:01.000Z' updatedAt: '2023-09-13T14:31:25.000Z' uid: 12345678-c616506e-0676-4d79-88a7-c273b70e9cea - name: Test E id: bf6fd735-125e-486b-b7fb-9f0ae4a0bbc5 protocolProfileBehavior: disableBodyPruning: true request: auth: type: bearer bearer: - key: token value: TEST type: string method: PATCH header: [] body: mode: raw raw: |- { "username": "test-user", "firstName": "Test", "lastName": "User" } options: raw: language: json url: raw: https://postman-echo.com/get?id=12345678 protocol: https host: - postman-echo - com path: - get query: - key: id value: '12345678' description: Optional. The user's ID. description: This is an example GET request. response: - id: 86447cb0-aeac-4371-a22f-9f6067fc4dd0 name: Successful Response originalRequest: method: GET header: - key: Content-Type name: Content-Type value: application/json type: text body: mode: raw raw: |- { "firstName": "Test", "lastName": "User" } options: raw: language: json url: raw: https://postman-echo.com/get?id=1234 protocol: https host: - postman-echo - com path: - get query: - key: id value: '1234' description: Optional. The user's ID. status: OK code: 200 _postman_previewlanguage: json header: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookie: [] responseTime: null body: |- { "id": "1234", "user": "test-user" } createdAt: '2023-09-13T14:05:22.000Z' updatedAt: '2023-09-13T14:13:21.000Z' uid: 12345678-86447cb0-aeac-4371-a22f-9f6067fc4dd0 createdAt: '2023-09-13T14:05:22.000Z' updatedAt: '2023-09-13T14:14:41.000Z' uid: 12345678-bf6fd735-125e-486b-b7fb-9f0ae4a0bbc5 id: a7046e3e-fb60-44fc-8e32-a4578b854628 auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: api-key type: string event: - listen: prerequest script: type: text/javascript exec: - pm.sendRequest("https://postman-echo.com/get", function (err, response) { - ' console.log(response.json());' - '});' - listen: test script: type: text/javascript exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' createdAt: '2023-09-12T15:46:34.000Z' updatedAt: '2023-09-13T14:05:22.000Z' uid: 12345678-a7046e3e-fb60-44fc-8e32-a4578b854628 - name: Test A event: - listen: test script: exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' type: text/javascript - listen: prerequest script: exec: - pm.sendRequest("https://postman-echo.com/get", function (err, response) { - ' console.log(response.json());' - '});' type: text/javascript id: bb4a826b-1654-4f24-9ab1-d00e4fc2d743 protocolProfileBehavior: disableBodyPruning: true request: auth: type: bearer bearer: - key: token value: TEST type: string method: GET header: - key: Accept value: application/vnd.example.v1+json type: text body: mode: raw raw: '' options: raw: language: json url: raw: http://api.getpostman.com/v1/request?id=12345678 protocol: http host: - api - getpostman - com path: - v1 - request query: - key: id value: '12345678' description: The API's ID. description: This is a test API. response: - id: 5f297469-80d7-4847-a3e2-f596f2e717d8 name: Successful Response originalRequest: method: POST header: - key: Host value: postman-echo.com - key: user-agent value: curl/7.88.1 - key: accept value: '*/*' - key: content-type value: application/json - key: content-length value: '22' body: mode: raw raw: |- { "field": "Value" } options: raw: language: json url: raw: https://postman-echo.com/post protocol: https host: - postman-echo - com path: - post status: OK code: 200 _postman_previewlanguage: json header: - key: date value: Thu, 07 Sep 2023 12:41:59 GMT - key: content-type value: application/json; charset=utf-8 - key: content-length value: '468' - key: etag value: W/"1d4-JuAIw8ssoFCtGzk/UwITxaiSbrc" - key: set-cookie value: sails.sid=s%3A6p_NXpI3OZeGE35bI6i5Uq3XgHHxcsdJ.dQVpBE%2BJ9wHWainkqe6F6dkdv7UKoshSZY7sdZ5sbzo; Path=/ HttpOnly cookie: [] responseTime: null body: | { "args": {}, "data": { "field": "Value" }, "files": {}, "form": {}, "headers": { "x-forwarded-proto": "https", "x-forwarded-port": "443", "host": "postman-echo.com", "x-amzn-trace-id": "Root=1-64f9c517-36db304817c774d740619baa", "content-length": "22", "user-agent": "curl/7.88.1", "accept": "*/*", "content-type": "application/json" }, "json": { "field": "Value" }, "url": "https://postman-echo.com/post" } createdAt: '2023-09-12T18:34:27.000Z' updatedAt: '2023-09-13T14:04:37.000Z' uid: 12345678-5f297469-80d7-4847-a3e2-f596f2e717d8 - id: 789df3cf-9362-40f7-a69e-4adde47d2bc8 name: Not Found originalRequest: method: GET header: - key: Accept value: application/vnd.example.v1+json type: text body: mode: raw raw: '' options: raw: language: json url: raw: http://api.getpostman.com/v1/request?id=test-api protocol: http host: - api - getpostman - com path: - v1 - request query: - key: id value: test-api status: Not Found code: 404 _postman_previewlanguage: json header: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookie: [] responseTime: null body: |- { "title": "Not Found", "detail": "Requested API does not exist", "type": "about:blank" } createdAt: '2023-08-22T12:53:12.000Z' updatedAt: '2023-09-13T14:04:32.000Z' uid: 12345678-789df3cf-9362-40f7-a69e-4adde47d2bc8 createdAt: '2022-10-05T13:09:24.000Z' updatedAt: '2025-04-25T17:29:16.000Z' uid: 12345678-bb4a826b-1654-4f24-9ab1-d00e4fc2d743 - name: Test B id: 3e2b5890-8fb9-4a73-bf7b-f0a161502513 protocolProfileBehavior: disableBodyPruning: true request: method: PUT header: [] body: mode: raw raw: |- { "name": "Test", "description": "This is a test." } options: raw: language: json url: raw: http://api.getpostman.com/v1/request protocol: http host: - api - getpostman - com path: - v1 - request response: - id: c7ffac80-0ab7-45da-a966-10bf469936db name: Test B originalRequest: method: PUT header: - key: Content-Type name: Content-Type value: application/json type: text body: mode: raw raw: |- { "firstName": "Test", "lastName": "User" } options: raw: language: json url: raw: http://api.getpostman.com/v1/request protocol: http host: - api - getpostman - com path: - v1 - request status: OK code: 200 _postman_previewlanguage: json header: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookie: [] responseTime: null body: |- { "id": "1234", "user": "test-user" } createdAt: '2023-09-12T15:20:20.000Z' updatedAt: '2023-09-13T14:13:44.000Z' uid: 12345678-c7ffac80-0ab7-45da-a966-10bf469936db createdAt: '2022-10-05T13:16:49.000Z' updatedAt: '2023-09-13T14:08:04.000Z' uid: 12345678-3e2b5890-8fb9-4a73-bf7b-f0a161502513 - name: Test C event: - listen: test script: exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' type: text/javascript - listen: prerequest script: exec: - '' type: text/javascript id: 98518f83-1da1-4d27-8253-432cc923dbae protocolProfileBehavior: disableBodyPruning: true request: auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: api-key type: string method: POST header: [] body: mode: raw raw: |- { "name": "Test API", "description": "This is a test API." } options: raw: language: json url: raw: https://postman-echo.com/post protocol: https host: - postman-echo - com path: - post response: - id: bb3cb97c-619e-4c81-9a14-139efe81816c name: Successful Response originalRequest: method: POST header: [] body: mode: raw raw: |- { "name": "Test API", "description": "This is a test API." } options: raw: language: json url: raw: https://postman-echo.com/post protocol: https host: - postman-echo - com path: - post _postman_previewlanguage: json header: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookie: [] responseTime: null body: |- { "id": "test-api", "name": "Test API", "description": "This is a test API.", "is_public": false, "created_at": "2022-01-28T11:50:56.000Z", "updated_at": "2022-01-28T11:50:56.000Z", "performance": { "collection": "123e4567-e89b-12d3-a456-556642440000", "environment": "123e4567-e89b-12d3-a456-556642440000" } } createdAt: '2023-09-12T15:21:55.000Z' updatedAt: '2023-09-13T14:33:26.000Z' uid: 12345678-bb3cb97c-619e-4c81-9a14-139efe81816c createdAt: '2023-09-07T14:03:52.000Z' updatedAt: '2023-09-13T14:26:58.000Z' uid: 12345678-98518f83-1da1-4d27-8253-432cc923dbae id: c9a0e43c-6078-4fa0-8cfc-d4dc9e889817 description: This is a test folder. auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: x-api-key type: string event: - listen: prerequest script: type: text/javascript exec: - pm.variables.get("variable_key"); - listen: test script: type: text/javascript exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' createdAt: '2022-10-05T13:09:28.000Z' updatedAt: '2023-09-13T14:32:34.000Z' uid: 12345678-c9a0e43c-6078-4fa0-8cfc-d4dc9e889817 - name: Folder 3 item: - name: ID item: - name: Request 3-A id: a22f41d5-32bf-4830-8731-10ad18e88874 protocolProfileBehavior: disableBodyPruning: true request: method: GET header: [] body: mode: raw raw: '' options: raw: language: json url: raw: '' response: [] createdAt: '2023-09-14T12:44:28.000Z' updatedAt: '2023-09-15T16:25:21.000Z' uid: 12345678-a22f41d5-32bf-4830-8731-10ad18e88874 id: 07f106de-776e-4fd8-9fc1-dc72e4a06a00 description: Test folder user ID. createdAt: '2023-09-13T21:54:44.000Z' updatedAt: '2023-09-15T16:26:42.000Z' uid: 12345678-07f106de-776e-4fd8-9fc1-dc72e4a06a00 - name: User item: - name: New Request id: 69e1ed6c-9d7b-41cd-aff7-69a468cf8252 protocolProfileBehavior: disableBodyPruning: true request: method: POST header: [] url: raw: '' response: [] createdAt: '2023-09-14T14:02:27.000Z' updatedAt: '2023-09-14T14:02:59.000Z' uid: 12345678-69e1ed6c-9d7b-41cd-aff7-69a468cf8252 - name: New Request id: 8b50cfc3-6af3-446e-a607-8d05e38e1ce9 protocolProfileBehavior: disableBodyPruning: true request: method: GET header: [] url: raw: '' response: [] createdAt: '2023-09-14T14:02:49.000Z' updatedAt: '2023-09-14T14:02:49.000Z' uid: 12345678-8b50cfc3-6af3-446e-a607-8d05e38e1ce9 id: 2c9de017-885f-4c1e-99bf-d10cd870fb0b description: Test folder for user information. createdAt: '2023-09-13T21:56:35.000Z' updatedAt: '2023-09-15T16:26:54.000Z' uid: 12345678-2c9de017-885f-4c1e-99bf-d10cd870fb0b - name: Test A id: 8b29623b-9c9c-4fed-ab9e-85f64524977b protocolProfileBehavior: disableBodyPruning: true request: method: GET header: [] url: raw: http://api.getpostman.com/v1/request protocol: http host: - api - getpostman - com path: - v1 - request response: [] createdAt: '2022-11-18T15:42:45.000Z' updatedAt: '2023-09-13T14:07:08.000Z' uid: 12345678-8b29623b-9c9c-4fed-ab9e-85f64524977b id: 7d1ea228-82fc-4887-833a-caf88d3182d5 description: This is a test folder. auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: x-api-key type: string event: - listen: prerequest script: type: text/javascript exec: - pm.sendRequest("https://postman-echo.com/get", function (err, response) { - ' console.log(response.json());' - '});' - listen: test script: type: text/javascript exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' createdAt: '2022-10-05T13:09:34.000Z' updatedAt: '2023-09-15T18:22:13.000Z' uid: 12345678-7d1ea228-82fc-4887-833a-caf88d3182d5 - name: Test F id: ff460862-473c-41b8-8be4-a493041c3351 protocolProfileBehavior: disableBodyPruning: true request: method: POST header: [] url: raw: '' response: [] createdAt: '2023-08-22T12:51:45.000Z' updatedAt: '2025-05-29T16:04:09.000Z' uid: 12345678-ff460862-473c-41b8-8be4-a493041c3351 getCollectionResponseWithModelMinimal: value: collection: info: _postman_id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection description: This is a test. updatedAt: '2023-10-13T08:14:22.000Z' uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 createdAt: '2023-10-09T18:34:58.000Z' lastUpdatedBy: '12345678' variable: - key: userId value: '12345678' disabled: true description: The user's ID. auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: x-api-key type: string events: - listen: prerequest script: id: 95d3e370-b6eb-42f5-9a98-8f276742037d type: text/javascript exec: - '' - listen: test script: id: d09029f2-ab45-4a80-b167-90a4c49bf64e type: text/javascript exec: - '' rootLevelRequests: - 12345678-8178d96f-7504-4273-9ca2-26c2ac725a5b - 12345678-fd7565b1-ec19-4d16-b5d4-a3116d1972fb - 12345678-3860896c-11fe-4c32-9f0a-88625977c8dc rootLevelFolders: - 12345678-803151f5-57f1-4ae5-8f75-4919dbd20372 getCollectionGetCollectionWithAccessKey: value: collection: info: _postman_id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection description: This is a test. schema: https://schema.getpostman.com/json/collection/v2.1.0/collection.json updatedAt: '2023-10-09T18:34:58.000Z' createdAt: '2023-10-09T18:34:58.000Z' lastUpdatedBy: '12345678' uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 item: - name: Folder 1 item: - name: ID item: - name: Test D event: - listen: prerequest script: exec: - pm.sendRequest("https://postman-echo.com/get", function (err, response) { - ' console.log(response.json());' - '});' type: text/javascript - listen: test script: exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' type: text/javascript id: c616506e-0676-4d79-88a7-c273b70e9cea protocolProfileBehavior: disableBodyPruning: true request: auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: api-key type: string method: GET header: [] url: raw: https://postman-echo.com/get?id=12345678 protocol: https host: - postman-echo - com path: - get query: - key: id value: '12345678' description: Optional. The user's ID. description: This is an example GET request. response: - id: d20b9562-9c85-4f25-bb2d-cfacf7dd85d1 name: Successful Response originalRequest: method: GET header: - key: Content-Type name: Content-Type value: application/json type: text url: raw: https://postman-echo.com/get?id=1234 protocol: https host: - postman-echo - com path: - get query: - key: id value: '1234' description: Optional. The user's ID. status: OK code: 200 _postman_previewlanguage: json header: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookie: [] responseTime: null body: |- { "id": "1234", "user": "test-user", "firstName": "Test", "lastName": "User" } createdAt: '2023-08-22T12:52:01.000Z' updatedAt: '2023-09-13T14:31:25.000Z' uid: 12345678-d20b9562-9c85-4f25-bb2d-cfacf7dd85d1 createdAt: '2023-08-22T12:52:01.000Z' updatedAt: '2023-09-13T14:31:25.000Z' uid: 12345678-c616506e-0676-4d79-88a7-c273b70e9cea - name: Test E id: bf6fd735-125e-486b-b7fb-9f0ae4a0bbc5 protocolProfileBehavior: disableBodyPruning: true request: auth: type: bearer bearer: - key: token value: TEST type: string method: PATCH header: [] body: mode: raw raw: |- { "username": "test-user", "firstName": "Test", "lastName": "User" } options: raw: language: json url: raw: https://postman-echo.com/get?id=12345678 protocol: https host: - postman-echo - com path: - get query: - key: id value: '12345678' description: Optional. The user's ID. description: This is an example GET request. response: - id: 86447cb0-aeac-4371-a22f-9f6067fc4dd0 name: Successful Response originalRequest: method: GET header: - key: Content-Type name: Content-Type value: application/json type: text body: mode: raw raw: |- { "firstName": "Test", "lastName": "User" } options: raw: language: json url: raw: https://postman-echo.com/get?id=1234 protocol: https host: - postman-echo - com path: - get query: - key: id value: '1234' description: Optional. The user's ID. status: OK code: 200 _postman_previewlanguage: json header: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookie: [] responseTime: null body: |- { "id": "1234", "user": "test-user" } createdAt: '2023-09-13T14:05:22.000Z' updatedAt: '2023-09-13T14:13:21.000Z' uid: 12345678-86447cb0-aeac-4371-a22f-9f6067fc4dd0 createdAt: '2023-09-13T14:05:22.000Z' updatedAt: '2023-09-13T14:14:41.000Z' uid: 12345678-bf6fd735-125e-486b-b7fb-9f0ae4a0bbc5 id: a7046e3e-fb60-44fc-8e32-a4578b854628 auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: api-key type: string event: - listen: prerequest script: type: text/javascript exec: - pm.sendRequest("https://postman-echo.com/get", function (err, response) { - ' console.log(response.json());' - '});' - listen: test script: type: text/javascript exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' createdAt: '2023-09-12T15:46:34.000Z' updatedAt: '2023-09-13T14:05:22.000Z' uid: 12345678-a7046e3e-fb60-44fc-8e32-a4578b854628 - name: Test A event: - listen: test script: exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' type: text/javascript - listen: prerequest script: exec: - pm.sendRequest("https://postman-echo.com/get", function (err, response) { - ' console.log(response.json());' - '});' type: text/javascript id: bb4a826b-1654-4f24-9ab1-d00e4fc2d743 protocolProfileBehavior: disableBodyPruning: true request: auth: type: bearer bearer: - key: token value: TEST type: string method: GET header: - key: Accept value: application/vnd.example.v1+json type: text body: mode: raw raw: '' options: raw: language: json url: raw: http://api.getpostman.com/v1/request?id=12345678 protocol: http host: - api - getpostman - com path: - v1 - request query: - key: id value: '12345678' description: The API's ID. description: This is a test API. response: - id: 5f297469-80d7-4847-a3e2-f596f2e717d8 name: Successful Response originalRequest: method: POST header: - key: Host value: postman-echo.com - key: user-agent value: curl/7.88.1 - key: accept value: '*/*' - key: content-type value: application/json - key: content-length value: '22' body: mode: raw raw: |- { "field": "Value" } options: raw: language: json url: raw: https://postman-echo.com/post protocol: https host: - postman-echo - com path: - post status: OK code: 200 _postman_previewlanguage: json header: - key: date value: Thu, 07 Sep 2023 12:41:59 GMT - key: content-type value: application/json; charset=utf-8 - key: content-length value: '468' - key: etag value: W/"1d4-JuAIw8ssoFCtGzk/UwITxaiSbrc" - key: set-cookie value: sails.sid=s%3A6p_NXpI3OZeGE35bI6i5Uq3XgHHxcsdJ.dQVpBE%2BJ9wHWainkqe6F6dkdv7UKoshSZY7sdZ5sbzo; Path=/ HttpOnly cookie: [] responseTime: null body: | { "args": {}, "data": { "field": "Value" }, "files": {}, "form": {}, "headers": { "x-forwarded-proto": "https", "x-forwarded-port": "443", "host": "postman-echo.com", "x-amzn-trace-id": "Root=1-64f9c517-36db304817c774d740619baa", "content-length": "22", "user-agent": "curl/7.88.1", "accept": "*/*", "content-type": "application/json" }, "json": { "field": "Value" }, "url": "https://postman-echo.com/post" } createdAt: '2023-09-12T18:34:27.000Z' updatedAt: '2023-09-13T14:04:37.000Z' uid: 12345678-5f297469-80d7-4847-a3e2-f596f2e717d8 - id: 789df3cf-9362-40f7-a69e-4adde47d2bc8 name: Not Found originalRequest: method: GET header: - key: Accept value: application/vnd.example.v1+json type: text body: mode: raw raw: '' options: raw: language: json url: raw: http://api.getpostman.com/v1/request?id=test-api protocol: http host: - api - getpostman - com path: - v1 - request query: - key: id value: test-api status: Not Found code: 404 _postman_previewlanguage: json header: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookie: [] responseTime: null body: |- { "title": "Not Found", "detail": "Requested API does not exist", "type": "about:blank" } createdAt: '2023-08-22T12:53:12.000Z' updatedAt: '2023-09-13T14:04:32.000Z' uid: 12345678-789df3cf-9362-40f7-a69e-4adde47d2bc8 createdAt: '2022-10-05T13:09:24.000Z' updatedAt: '2025-04-25T17:29:16.000Z' uid: 12345678-bb4a826b-1654-4f24-9ab1-d00e4fc2d743 - name: Test B id: 3e2b5890-8fb9-4a73-bf7b-f0a161502513 protocolProfileBehavior: disableBodyPruning: true request: method: PUT header: [] body: mode: raw raw: |- { "name": "Test", "description": "This is a test." } options: raw: language: json url: raw: http://api.getpostman.com/v1/request protocol: http host: - api - getpostman - com path: - v1 - request response: - id: c7ffac80-0ab7-45da-a966-10bf469936db name: Test B originalRequest: method: PUT header: - key: Content-Type name: Content-Type value: application/json type: text body: mode: raw raw: |- { "firstName": "Test", "lastName": "User" } options: raw: language: json url: raw: http://api.getpostman.com/v1/request protocol: http host: - api - getpostman - com path: - v1 - request status: OK code: 200 _postman_previewlanguage: json header: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookie: [] responseTime: null body: |- { "id": "1234", "user": "test-user" } createdAt: '2023-09-12T15:20:20.000Z' updatedAt: '2023-09-13T14:13:44.000Z' uid: 12345678-c7ffac80-0ab7-45da-a966-10bf469936db createdAt: '2022-10-05T13:16:49.000Z' updatedAt: '2023-09-13T14:08:04.000Z' uid: 12345678-3e2b5890-8fb9-4a73-bf7b-f0a161502513 - name: Test C event: - listen: test script: exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' type: text/javascript - listen: prerequest script: exec: - '' type: text/javascript id: 98518f83-1da1-4d27-8253-432cc923dbae protocolProfileBehavior: disableBodyPruning: true request: auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: api-key type: string method: POST header: [] body: mode: raw raw: |- { "name": "Test API", "description": "This is a test API." } options: raw: language: json url: raw: https://postman-echo.com/post protocol: https host: - postman-echo - com path: - post response: - id: bb3cb97c-619e-4c81-9a14-139efe81816c name: Successful Response originalRequest: method: POST header: [] body: mode: raw raw: |- { "name": "Test API", "description": "This is a test API." } options: raw: language: json url: raw: https://postman-echo.com/post protocol: https host: - postman-echo - com path: - post _postman_previewlanguage: json header: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookie: [] responseTime: null body: |- { "id": "test-api", "name": "Test API", "description": "This is a test API.", "is_public": false, "created_at": "2022-01-28T11:50:56.000Z", "updated_at": "2022-01-28T11:50:56.000Z", "performance": { "collection": "123e4567-e89b-12d3-a456-556642440000", "environment": "123e4567-e89b-12d3-a456-556642440000" } } createdAt: '2023-09-12T15:21:55.000Z' updatedAt: '2023-09-13T14:33:26.000Z' uid: 12345678-bb3cb97c-619e-4c81-9a14-139efe81816c createdAt: '2023-09-07T14:03:52.000Z' updatedAt: '2023-09-13T14:26:58.000Z' uid: 12345678-98518f83-1da1-4d27-8253-432cc923dbae id: c9a0e43c-6078-4fa0-8cfc-d4dc9e889817 description: This is a test folder. auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: x-api-key type: string event: - listen: prerequest script: type: text/javascript exec: - pm.variables.get("variable_key"); - listen: test script: type: text/javascript exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' createdAt: '2022-10-05T13:09:28.000Z' updatedAt: '2023-09-13T14:32:34.000Z' uid: 12345678-c9a0e43c-6078-4fa0-8cfc-d4dc9e889817 - name: Folder 3 item: - name: ID item: - name: Request 3-A id: a22f41d5-32bf-4830-8731-10ad18e88874 protocolProfileBehavior: disableBodyPruning: true request: method: GET header: [] body: mode: raw raw: '' options: raw: language: json url: raw: '' response: [] createdAt: '2023-09-14T12:44:28.000Z' updatedAt: '2023-09-15T16:25:21.000Z' uid: 12345678-a22f41d5-32bf-4830-8731-10ad18e88874 id: 07f106de-776e-4fd8-9fc1-dc72e4a06a00 description: Test folder user ID. createdAt: '2023-09-13T21:54:44.000Z' updatedAt: '2023-09-15T16:26:42.000Z' uid: 12345678-07f106de-776e-4fd8-9fc1-dc72e4a06a00 - name: User item: - name: New Request id: 69e1ed6c-9d7b-41cd-aff7-69a468cf8252 protocolProfileBehavior: disableBodyPruning: true request: method: POST header: [] url: raw: '' response: [] createdAt: '2023-09-14T14:02:27.000Z' updatedAt: '2023-09-14T14:02:59.000Z' uid: 12345678-69e1ed6c-9d7b-41cd-aff7-69a468cf8252 - name: New Request id: 8b50cfc3-6af3-446e-a607-8d05e38e1ce9 protocolProfileBehavior: disableBodyPruning: true request: method: GET header: [] url: raw: '' response: [] createdAt: '2023-09-14T14:02:49.000Z' updatedAt: '2023-09-14T14:02:49.000Z' uid: 12345678-8b50cfc3-6af3-446e-a607-8d05e38e1ce9 id: 2c9de017-885f-4c1e-99bf-d10cd870fb0b description: Test folder for user information. createdAt: '2023-09-13T21:56:35.000Z' updatedAt: '2023-09-15T16:26:54.000Z' uid: 12345678-2c9de017-885f-4c1e-99bf-d10cd870fb0b - name: Test A id: 8b29623b-9c9c-4fed-ab9e-85f64524977b protocolProfileBehavior: disableBodyPruning: true request: method: GET header: [] url: raw: http://api.getpostman.com/v1/request protocol: http host: - api - getpostman - com path: - v1 - request response: [] createdAt: '2022-11-18T15:42:45.000Z' updatedAt: '2023-09-13T14:07:08.000Z' uid: 12345678-8b29623b-9c9c-4fed-ab9e-85f64524977b id: 7d1ea228-82fc-4887-833a-caf88d3182d5 description: This is a test folder. auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: x-api-key type: string event: - listen: prerequest script: type: text/javascript exec: - pm.sendRequest("https://postman-echo.com/get", function (err, response) { - ' console.log(response.json());' - '});' - listen: test script: type: text/javascript exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' createdAt: '2022-10-05T13:09:34.000Z' updatedAt: '2023-09-15T18:22:13.000Z' uid: 12345678-7d1ea228-82fc-4887-833a-caf88d3182d5 - name: Test F id: ff460862-473c-41b8-8be4-a493041c3351 protocolProfileBehavior: disableBodyPruning: true request: method: POST header: [] url: raw: '' response: [] createdAt: '2023-08-22T12:51:45.000Z' updatedAt: '2025-05-29T16:04:09.000Z' uid: 12345678-ff460862-473c-41b8-8be4-a493041c3351 auth: type: apikey apikey: - key: value value: abc123 type: string - key: key value: x-api-key type: string event: - listen: prerequest script: id: cc22c328-3dcc-46c1-a357-7e2f72f54cf6 type: text/javascript packages: {} exec: - try { - ' const response = await pm.sendRequest({' - ' url: "https://postman-echo.com/get",' - ' method: "GET"' - ' });' - '' - ' console.log(response.json());' - '} catch (err) {' - ' console.error(err);' - '}' - listen: test script: id: 5db243ea-5022-4d08-a620-b8fb9d561af5 type: text/javascript packages: {} exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' variable: - key: userId value: '12345678' disabled: true description: The user's ID. collection400ErrorCollectionNotFound: value: error: name: instanceNotFoundError message: We could not find the collection you are looking for putCollection: value: collection: info: name: Test User Collection description: This is a basic test user collection. schema: https://schema.postman.com/json/collection/v2.1.0/collection.json item: - name: Get a user event: - listen: prerequest script: id: fd554123-3124-444c-a4ab-a2ed3c21b794 exec: - try { - ' const response = await pm.sendRequest({' - ' url: "https://postman-echo.com/get",' - ' method: "GET"' - ' });' - '' - ' console.log(response.json());' - '} catch (err) {' - ' console.error(err);' - '}' type: text/javascript packages: {} - listen: test script: id: 85a17bb9-3626-4f86-b206-79798e5f8cd7 exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' type: text/javascript packages: {} id: 5e1bef64-8201-489b-b07c-a1723e008594 protocolProfileBehavior: disableBodyPruning: true strictSSL: true request: method: GET header: [] url: raw: http://api.postman.com/v1/:userId protocol: http host: - api - postman - com path: - v1 - :userId variable: - key: userId value: '{{userId}}' description: The user ID. description: Gets information about a user. response: - id: da76da3c-c418-4f72-b47a-24c540badd37 name: 200 OK originalRequest: method: GET header: [] url: raw: http://api.postman.com/v1/:userId protocol: http host: - api - postman - com path: - v1 - :userId variable: - key: userId value: '{{userId}}' description: The user ID. status: OK code: 200 _postman_previewlanguage: json header: - key: Content-Type value: application/json description: '' type: text cookie: [] responseTime: null body: |- { "name": "Test User", "userId": 12345678 } uid: 12345678-da76da3c-c418-4f72-b47a-24c540badd37 uid: 12345678-5e1bef64-8201-489b-b07c-a1723e008594 - name: Delete a user id: 496c0ff9-e602-4506-b7dc-00ecd709d5eb protocolProfileBehavior: disableBodyPruning: true request: method: DELETE header: [] url: raw: http://api.postman.com/v1/:userId protocol: http host: - api - postman - com path: - v1 - :userId variable: - key: userId value: '{{userId}}' description: The user ID. description: Deletes a user. response: - id: 06f9ea8b-55a7-4e8e-ae12-891a050367de name: 204 No Content originalRequest: method: DELETE header: [] url: raw: http://api.postman.com/v1/:userId protocol: http host: - api - postman - com path: - v1 - :userId variable: - key: userId value: '{{userId}}' description: The user ID. status: No Content code: 204 _postman_previewlanguage: null header: null cookie: [] responseTime: null body: null uid: 12345678-06f9ea8b-55a7-4e8e-ae12-891a050367de uid: 12345678-496c0ff9-e602-4506-b7dc-00ecd709d5eb auth: type: apikey apikey: - key: value value: '{{api-key}}' - key: key value: x-api-key event: - listen: prerequest script: id: 86cc41c1-a9ad-411f-923d-5f1d15344c94 type: text/javascript packages: {} exec: - '' - listen: test script: id: 9f48d011-89cb-4a85-9179-b3554aa44aff type: text/javascript packages: {} exec: - pm.test("Content-Type is present", function () { - ' pm.response.to.have.header("Content-Type");' - '});' variable: - key: userId value: '12345678' description: The user's ID. putCollectionReplaceABasicCollectionSData: value: collection: id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 putCollectionReplaceADetailedCollectionSData: value: collection: id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 putCollectionCopyAnotherCollectionSContents: value: collection: id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 putCollectionDisableARequestSQueryParams: value: collection: id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 putCollectionAsyncUpdateInProgress: value: task: id: be15d43c-0ca9-427b-b073-1c4228f32f8d status: in-progress collectionPut400ErrorsMalformedRequest: value: error: name: malformedRequestError message: Found 2 errors with the supplied collection. details: - ': must have required property ''item''' - 'info: must have required property ''schema''' collectionPut400ErrorsCollectionIDMismatch: value: error: name: collectionMismatchError message: The collection ID in the path does not match the collection ID in the request body. collectionPut400ErrorsInvalidSchema: value: type: https://api.postman.com/problems/bad-request title: Malformed request status: 400 detail: Unable to parse the collection. Please ensure it is according to https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html collectionPut400ErrorsMissingCollectionProperty: value: type: https://api.postman.com/problems/bad-request title: Missing property 'collection' status: 400 detail: 'PUT request body for ''/collections/12ece9e1-2abf-4edc-8e34-de66e74114d2'' failed to validate schema. Location: /required' collectionPut400ErrorsMissingInfoProperty: value: type: https://api.postman.com/problems/bad-request title: Missing property 'info' status: 400 detail: 'PUT request body for ''/collections/12ece9e1-2abf-4edc-8e34-de66e74114d2'' failed to validate schema. Location: /properties/collection/required' collectionPut404ErrorsInstanceNotFoundError: value: error: name: instanceNotFoundError message: The specified item does not exist. details: item: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 collectionPut404ErrorsNotFound: value: type: https://api.postman.com/problems/not-found title: Not found status: 404 detail: We could not find the collection you are looking for collectionPut409ErrorsOperationInProgress: value: type: https://api.postman.com/problems/conflict status: 409 title: Conflict detail: Deep update operation is already in progress for this collection. deleteCollectionSuccessfulResponse: value: collection: id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 patchCollectionAuth: value: collection: auth: type: apikey apikey: - key: value value: '{{apiKey}}' - key: key value: X-Api-Key - key: in value: header patchCollectionEvents: value: collection: events: - listen: prerequest script: id: e74ce0d0-5acd-44b6-a3ae-95f617c1546e type: text/javascript exec: - '' - listen: test script: id: 28dc4f71-73bd-49cb-a6bd-8b41a06a3b36 type: text/javascript exec: - '' patchCollectionInfo: value: collection: info: name: Test Collection v2 description: This is a sample collection that makes a request to the Postman Echo service. It returns a list of request headers sent by an HTTP client. patchCollectionVariables: value: collection: variable: - key: userId value: '12345678' disabled: true description: The user's ID. - enabled: true key: apiKey secret: true source: postman: secretId: f5fa5280-18a3-4d93-a706-2fe48b1007dc type: cloud vaultId: 453a311c-c5b4-4627-8e51-a3bd48953734 provider: postman patchCollectionUpdateInfo: value: collection: id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection v2 description: This is a sample collection that makes a request to the Postman Echo service. It returns a list of request headers sent by an HTTP client. patchCollectionUpdateVariables: value: collection: id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection v2 description: This is a sample collection that makes a request to the Postman Echo service. It returns a list of request headers sent by an HTTP client. patchCollectionUpdateEvents: value: collection: id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection v2 description: This is a sample collection that makes a request to the Postman Echo service. It returns a list of request headers sent by an HTTP client. patchCollectionUpdateAuth: value: collection: id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection v2 description: This is a sample collection that makes a request to the Postman Echo service. It returns a list of request headers sent by an HTTP client. collectionPatch400ErrorsInvalidAuthType: value: error: name: badRequest message: 'Invalid parameters: (''apikey'') for key: ''collection.auth.type''' collectionPatch400ErrorsInvalidVariableParameter: value: error: name: badRequest message: 'Invalid parameters: (''property'') for key: ''collection.variables''' collectionPatch400ErrorsInvalidEventsParameter: value: error: name: badRequest message: 'Invalid parameters: (''property'') for key: ''collection.events.script''' collectionPatch400ErrorsInvalidEventsIdParameter: value: error: name: badRequest message: 'Invalid parameters: (''id'') for key: ''collection.events''' collectionPatch400ErrorsMissingVariableParameter: value: error: name: badRequest message: 'Parameters required: (''value'') for key: ''collection.variables''' collectionPatch400ErrorsMissingInfoParameter: value: error: name: paramMissingError message: '''info'' key is mandatory when ''collection'' is empty.' details: param: info collectionPatch400ErrorsMissingEventsParameter: value: error: name: badRequest message: 'Parameters required: (''type'', ''exec'') for key: ''collection.events.script''' collectionPatch400ErrorsMissingAuthParameter: value: error: name: paramMissingError message: The key 'apikey' must be present in 'collection.auth' when 'type' is 'apikey'. details: param: apikey duplicateCollection: value: workspace: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 suffix: Copy duplicateCollectionSuccessfulResponse: value: task: id: 12345678-d2584d81-3283-42d5-9d84-b897257adcf0 status: processing createCollectionFolder: value: name: Test Folder description: This is a test collection folder. createCollectionFolderCreateAFolder: value: data: id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa name: Test Folder order: [] owner: '12345678' folder: null folders: [] requests: [] createdAt: '2022-08-29T16:49:19.964Z' updatedAt: '2022-08-29T16:49:19.964Z' collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 description: This is a test collection folder. folders_order: [] lastUpdatedBy: '12345678' meta: model: folder action: import model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa revision: 24994132707 createCollectionFolderCreateAChildFolder: value: model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa meta: model: folder action: import data: name: Child Folder collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 description: This is a child folder of Test Folder. folder: 4249383d-2af6-4ac6-9a2b-0930e8f639e3 order: [] folders_order: [] id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa owner: '12345678' lastUpdatedBy: '12345678' createdAt: '2023-08-16T13:47:47.474Z' updatedAt: '2023-08-16T13:47:47.474Z' requests: [] folders: [] revision: 32117045490 createCollectionFolderCreateAFolderWithRequestsAndResponses: value: data: collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 order: - c82dd02c-4870-4907-8fcb-593a876cf05b - c0160fa6-c38a-4589-ba74-92dcf59fde03 name: Test Folder description: This is a test collection folder. folder: null folders_order: [] id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa owner: '12345678' lastUpdatedBy: '12345678' createdAt: '2022-08-29T16:49:19.891Z' updatedAt: '2022-08-29T16:49:20.052Z' transactionId: 2039363d-2fe4-4c2f-9e06-347242d0e805 requests: - id: c82dd02c-4870-4907-8fcb-593a876cf05b method: POST dataMode: params tests: var data = JSON.parse(responseBody); description: This is an example POST request. headers: '' preRequestScript: null name: Example POST request pathVariables: {} url: https://postman-echo.com/v1/request collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 folder: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa responses_order: - cc364734-7dfd-4bfc-897d-be763dcdbb07 owner: '12345678' lastUpdatedBy: '12345678' events: - listen: test script: exec: - var data = JSON.parse(responseBody); type: text/javascript createdAt: '2022-08-29T16:49:19.961Z' updatedAt: '2022-08-29T16:49:19.961Z' data: - key: id type: text value: 3f14c9c7-e71c-4094-b90e-ac9edb232c2e enabled: true - key: collection type: text value: 12ece9e1-2abf-4edc-8e34-de66e74114d2 enabled: true dataOptions: params: null responses: - id: cc364734-7dfd-4bfc-897d-be763dcdbb07 data: - key: id type: text value: 3f14c9c7-e71c-4094-b90e-ac9edb232c2e enabled: true - key: collection type: text value: 12ece9e1-2abf-4edc-8e34-de66e74114d2 enabled: true mime: abc name: Success text: '[21,22,23,24]' time: '45' owner: '12345678' status: xyz cookies: - hostOnly: true httpOnly: false domain: localhost storeId: '0' secure: false name: undefined path: / session: false value: '0' expires: 11/1/2023 18:57:34 expirationDate: 1452535054 - hostOnly: true httpOnly: false domain: localhost storeId: '0' secure: false name: _ga path: / session: false value: GA1.1.1111420724.142
2561371 expires: 11/1/2023 18:57:34 expirationDate: 1485633370 headers: - name: Access-Control-Allow-Credentials key: Access-Control-Allow-Credentials value: '' description: '' - name: Access-Control-Allow-Headers key: Access-Control-Allow-Headers value: '' description: '' request: c82dd02c-4870-4907-8fcb-593a876cf05b dataMode: params language: html createdAt: '2022-08-29T16:49:20.029Z' updatedAt: '2022-08-29T16:49:20.029Z' rawDataType: text responseCode: code: 200 name: OK lastUpdatedBy: '12345678' requestObject: '{"name": "Postman Signup API", "description":"To sign up for Postman"}' - id: c0160fa6-c38a-4589-ba74-92dcf59fde03 url: https://postman-echo.com/v1/request data: - enabled: true key: id value: 3f14c9c7-e71c-4094-b90e-ac9edb232c2e type: text - enabled: true key: collection value: 12ece9e1-2abf-4edc-8e34-de66e74114d2 type: text name: Example GET request owner: '12345678' tests: var data = JSON.parse(responseBody); events: - listen: test script: type: text/javascript exec: - var data = JSON.parse(responseBody); folder: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa method: GET headers: '' dataMode: params createdAt: '2022-08-29T16:49:19.964Z' responses: [] updatedAt: '2022-08-29T16:49:19.964Z' collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 dataOptions: params: null description: This is an example GET request. lastUpdatedBy: '12345678' pathVariables: {} responses_order: [] preRequestScript: null folders: [] meta: model: folder action: import model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa revision: 26532147542 collectionFolder400ErrorBadRequest: value: error: name: instanceFoundError message: This folder already exists in the database. details: model: folder model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa owner: '12345678' collectionFolder400ErrorChangeParentError: value: error: name: changeParentError message: You can't update the parent. Use transfer instead. details: server: model: collection model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa request: model: collection model_id: 12345678-65a99e60-8e0a-4b6e-b79c-7d8264cc5caa collectionFolder400ErrorOrderUpdateError: value: error: name: orderUpdateError message: You can only reorder the requests. details: order: - 66c7fe01-2c7e-4149-9de1-1143592f7bad - 3def345e-b4b3-4319-8e2c-65d2630c0345 - c089bf09-c679-4116-9654-9a561276634d - eb82f2b7-0478-4068-8e8a-c277e25ba0d3 collectionFolder401ErrorUnauthorized: value: error: name: Unauthorized message: Unauthorized details: model: folder model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa owner: '12345678' getCollectionForksSuccessfulResponse: value: data: - forkName: Collection Fork forkId: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f createdBy: Taylor Lee createdAt: '2023-11-16T09:18:17.000Z' - forkName: Test Fork forkId: 87654321-38j9f1ad-2ee3-7890-dv5h-7742d82e2e1f createdBy: Alex Cruz createdAt: '2023-11-16T09:16:15.000Z' meta: total: 2 nextCursor: null getCollectionForksResponseWithCursor: value: data: - forkName: Test Fork forkId: 87654321-38j9f1ad-2ee3-7890-dv5h-7742d82e2e1f createdBy: Alex Cruz createdAt: '2023-11-16T09:16:15.000Z' - forkName: Collection Fork forkId: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f createdBy: '12345678' createdAt: '2023-11-15T08:12:27.000Z' meta: total: 2 nextCursor: null getCollectionForksResponseWithDirection: value: data: - forkName: Collection Fork forkId: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f createdBy: '12345678' createdAt: '2023-11-15T08:12:27.000Z' - forkName: Test Fork forkId: 87654321-38j9f1ad-2ee3-7890-dv5h-7742d82e2e1f createdBy: Alex Cruz createdAt: '2023-11-16T09:16:15.000Z' meta: total: 2 nextCursor: null getCollectionForksResponseWithLimit: value: data: - forkName: Collection Fork forkId: 12345678-667df1ad-2ee3-7890-b678-7742d82e2e1f createdBy: '12345678' createdAt: '2023-11-15T08:12:27.000Z' - forkName: Test Fork forkId: 87654321-38j9f1ad-2ee3-7890-dv5h-7742d82e2e1f createdBy: Alex Cruz createdAt: '2023-11-16T09:16:15.000Z' - forkName: My Fork forkId: 12345678-667df1ad-2gnm-7890-b678-7742d82e2e1f createdBy: Taylor Lee createdAt: '2023-10-03T10:00:07.000Z' - forkName: Testing forkId: 12345678-667df1ad-2ee3-ifb0-b678-7742d82e2e1f createdBy: Taylor Lee createdAt: '2023-12-18T00:02:25.000Z' - forkName: Example Fork forkId: 87654321-667df1ad-efbh-7880-b678-7742d82e2e1f createdBy: Alex Cruz createdAt: '2023-12-29T02:28:11.000Z' meta: total: 10 nextCursor: eyJpZCI6MzMyNzksImZvcmtzQWZ0ZXIiOjIwfQ== forkCollection400ErrorNoForks: value: error: name: badRequest message: This collection id has no forks. getCollectionForksBadRequest: value: error: name: badRequest message: This collection has no forks. fork404Error: value: error: name: notFoundError message: Fork not found. getGeneratedCollectionSpecs: value: meta: nextCursor: null specs: - id: e8a015e0-f472-4bb3-a523-57ce7c4583ef name: Sample API state: in-sync createdAt: '2025-03-15T13:48:28.000Z' updatedAt: '2025-03-15T13:48:28.000Z' createdBy: 12345678 updatedBy: 12345678 apiSpec404ErrorInstanceNotFound: value: type: instanceNotFoundError title: Instance not found status: 404 detail: Entity that you are trying to access does not exist. apiSpec404ErrorResourceNotFound: value: type: instanceNotFoundError title: Resource not found status: 404 detail: Entity that you are trying to access does not exist. apiSpec404ErrorSpecificationNotFound: value: type: instanceNotFoundError title: Specification not found status: 404 detail: The specification you are trying to access does not exist. apiSpec404ErrorVersionTagNotFound: value: type: instanceNotFoundError title: Version not found status: 404 detail: The version tag you are trying to access does not exist on this specification. generateSpecFromCollection: value: name: Sample API type: OPENAPI:3.0 format: JSON generateSpecTaskResponse: value: taskId: 66ae9950-0869-4e65-96b0-1e0e47e771af url: /specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/tasks/66ae9950-0869-4e65-96b0-1e0e47e771af generateCollectionTaskResponse: value: taskId: 66ae9950-0869-4e65-96b0-1e0e47e771af url: /collections/12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2/tasks/66ae9950-0869-4e65-96b0-1e0e47e771af apiSpec423ErrorLocked: value: type: actionLockedError title: Collection generation in progress status: 423 detail: Collection generation is already in progress for the spec. publishDocumentation: value: environmentUid: 12345678-f84a5105-a495-49db-aa6b-db02c9ed1023 customColor: highlight: EF5B25 rightSidebar: '303030' topBar: FFFFFF documentationLayout: classic-single-column customization: metaTags: - name: title value: Billing API - name: description value: This documentation contains the endpoints for the Billing API. appearance: default: dark themes: - name: dark colors: highlight: EF5B25 rightSidebar: '303030' topBar: FFFFFF logo: / - name: light colors: highlight: EF5B25 rightSidebar: '303030' topBar: FFFFFF logo: / publishDocumentationSuccessfulResponse: value: published: true documentationLayout: classic-single-column customization: appearance: default: dark themes: - name: dark colors: highlight: EF5B25 rightSidebar: '303030' topBar: FFFFFF logo: / - name: light colors: highlight: EF5B25 rightSidebar: '303030' topBar: FFFFFF logo: / metaTags: - name: description value: This documentation contains the endpoints for the Billing API. - name: title value: Billing API publishDate: '2025-03-24T17:33:10.000Z' publisherId: '12345678' environmentUid: 12345678-f84a5105-a495-49db-aa6b-db02c9ed1023 customColor: highlight: EF5B25 rightSidebar: '303030' topBar: FFFFFF publicUrl: https://documenter.getpostman-beta.com/view/12345678/6n31uVF id: 6n31uVF collectionId: ea39a259-0c9b-4a5c-a2e6-bddadb8f8e6f documentation400ErrorBadRequest: value: type: https://api.postman.com/problems/bad-request title: Bad Request detail: Collection Id not present status: 400 documentation400ErrorInvalidCustomColor: value: type: https://api.postman.com/problems/bad-request title: Bad Request detail: 'The request contains following incorrect or missing fields: light theme and customColor' status: 400 documentation400ErrorCustomColorMissing: value: type: https://api.postman.com/problems/bad-request title: Bad Request detail: Property 'customColor' is missing from the request body status: 400 documentation400ErrorCustomizationMissing: value: type: https://api.postman.com/problems/bad-request title: Bad Request detail: Property 'customization' is missing from the request body status: 400 common500Error: value: type: https://api.postman.com/problems/internal-server-error title: Internal Server Error detail: Internal Server Error status: 500 documentation404ErrorNotFound: value: type: https://api.postman.com/problems/not-found title: Not Found detail: The resource you're looking for can't be found. Please check the URL before trying again. status: 404 pullCollectionChangesSuccessfulResponse: value: collection: destinationId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 sourceId: 12345678-45499451-e894-41b8-8c66-8191ab64932a forkCollection400ErrorBadId: value: error: name: badRequest message: The collection Id is not a forked collection. pullCollectionChangesBadRequest: value: error: name: badRequest message: The collection is not a forked collection. getCollectionPullRequestsSuccessfulResponse: value: data: - createdAt: '2024-02-20T09:55:46.000Z' updatedAt: '2024-02-20T09:58:38.000Z' id: 4e1a6609-1a29-4037-a411-89ecc14c6cd8 href: /pull-requests/4e1a6609-1a29-4037-a411-89ecc14c6cd8 sourceId: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef destinationId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 title: Open PR description: This is an open pull request. createdBy: '12345678' updatedBy: '12345678' status: open - createdAt: '2024-02-20T09:58:57.000Z' updatedAt: '2024-02-20T09:58:57.000Z' id: ac959187-568f-4e5e-9d17-584eb44fbed2 href: /pull-requests/ac959187-568f-4e5e-9d17-584eb44fbed2 sourceId: 87654321-e50a18a3-0dcd-49cb-afa5-d3a82cdf6134 destinationId: 12345678-24f57217-1169-4b7c-a810-0e957c04eaa5 title: Approved PR description: This is an approved PR. createdBy: '12345678' updatedBy: '12345678' status: approved - createdAt: '2024-02-20T09:55:46.000Z' updatedAt: '2024-02-20T09:58:38.000Z' id: eda21e1f-8688-43aa-8660-35337dbac04b href: /pull-requests/eda21e1f-8688-43aa-8660-35337dbac04b sourceId: 87654321-4beee503-1a7a-4925-a165-16fc29eaad22 destinationId: 12345678-c7f30bd9-5cc7-4569-a5fe-92270af33c6c title: Declined PR description: This is a declined PR. createdBy: '12345678' updatedBy: '12345678' status: declined comment: Missing information. pullRequest403ErrorRolePermissionsCollection: value: type: https://api.postman.com/problems/forbidden title: Forbidden detail: You need Viewer role on both source and destination collections to view pull requests. Please contact collection editors to grant additional access to you. status: 403 pullRequest403ErrorNoViewerAccessCollections: value: type: https://api.postman.com/problems/forbidden title: Forbidden detail: You and all reviewers need Viewer access on both source and destination collections. status: 403 pullRequestReview400ErrorActionNotAllowed: value: type: https://api.postman.com/problems/bad-request title: Bad Request detail: Given action on current pull request is not allowed status: 400 pullRequest400ErrorDuplicate: value: type: https://api.postman.com/problems/bad-request title: Duplicate pull request detail: A pull request for this source and destination already exists. status: 400 pullRequestReview400ErrorInvalidAction: value: type: https://api.postman.com/problems/bad-request title: Value must be one of "approve", "unapprove", "decline", "merge" detail: 'POST request body for ''/pull-requests/4e1a6609-1a29-4037-a411-89ecc14c6cd8/tasks'' failed to validate schema. Location: /properties/action/enum' status: 400 forkCollection400ErrorBadForkRelation: value: type: https://api.postman.com/problems/bad-request title: Bad Request status: 400 detail: Fork relation not found createCollectionRequest: value: name: Example GET Request description: This is an example GET request. url: https://postman-echo.com/get?param=value method: GET headers: - key: Host value: postman-echo.com - key: user-agent value: curl/7.88.1 - key: accept value: '*/*' - key: content-type value: application/json queryParams: - key: id value: '{{id}}' equals: true description: Optional. The user's ID. enabled: true dataMode: raw rawModeData: null dataOptions: raw: language: json createCollectionRequestGETRequest: value: model_id: c82dd02c-4870-4907-8fcb-593a876cf05b meta: model: request action: import data: collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 method: GET headers: - key: Host value: postman-echo.com - key: user-agent value: curl/7.88.1 - key: accept value: '*/*' - key: content-type value: application/json dataMode: raw url: https://postman-echo.com/get?param=value name: Example GET Request description: This is an example GET request. owner: '12345678' folder: null responses_order: [] id: c82dd02c-4870-4907-8fcb-593a876cf05b lastUpdatedBy: '12345678' queryParams: - key: id value: '{{id}}' equals: true description: Optional. The user's ID. enabled: true headerData: [] createdAt: '2023-09-07T13:33:17.912Z' updatedAt: '2023-09-07T13:33:17.912Z' rawModeData: null dataOptions: raw: language: json responses: [] revision: 32456338071 createCollectionRequestPOSTRequest: value: model_id: c82dd02c-4870-4907-8fcb-593a876cf05b meta: model: request action: import data: collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 method: POST headers: - key: Host value: postman-echo.com - key: user-agent value: curl/7.88.1 - key: accept value: '*/*' - key: content-type value: application/json - key: content-length value: '22' dataMode: raw url: https://postman-echo.com/post name: Example POST Request owner: '12345678' folder: null responses_order: [] id: c82dd02c-4870-4907-8fcb-593a876cf05b lastUpdatedBy: '12345678' headerData: [] createdAt: '2023-09-07T13:35:33.691Z' updatedAt: '2023-09-07T13:35:33.691Z' rawModeData: null dataOptions: raw: language: json responses: [] revision: 32456382272 createCollectionRequestRequestInAFolder: value: model_id: c82dd02c-4870-4907-8fcb-593a876cf05b meta: model: request action: import data: folder: 4249383d-2af6-4ac6-9a2b-0930e8f639e3 collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 method: GET queryParams: - value: '{{id}}' key: id equals: true description: Optional. The user's ID. enabled: false description: This is an example GET request. url: https://postman-echo.com/get?param=value name: Example headers: - key: Host value: postman-echo.com - key: user-agent value: curl/7.88.1 - key: accept value: '*/*' - key: content-type value: application/json dataMode: raw responses_order: [] id: 389f1640-7996-b519-4747-9f3c6a350a19 owner: '20891195' lastUpdatedBy: '20891195' headerData: [] createdAt: '2023-09-13T18:03:16.957Z' updatedAt: '2023-09-13T18:03:16.957Z' rawModeData: null dataOptions: raw: language: json responses: [] revision: 32549528635 createCollectionRequestRequestWithAuth: value: model_id: c82dd02c-4870-4907-8fcb-593a876cf05b meta: model: request action: import data: folder: 4ec7de35-cc87-4e2f-ab01-6fd351371ad3 collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: api-key type: string currentHelper: apikeyAuth helperAttributes: '{"id":"apikey","key":"api-key","value":"XXX"}' description: This is an example GET request. url: https://postman-echo.com/get?param=value dataMode: raw name: Example GET Request method: GET headers: '[object Object],[object Object],[object Object],[object Object]' responses_order: [] id: c82dd02c-4870-4907-8fcb-593a876cf05b owner: '12345678' lastUpdatedBy: '12345678' queryParams: - key: id value: '{{id}}' equals: true description: Optional. The user's ID. enabled: true headerData: [] createdAt: '2022-10-07T13:57:54.145Z' updatedAt: '2022-10-07T13:57:54.145Z' rawModeData: null dataOptions: raw: language: json responses: [] revision: 27134451973 createCollectionRequestRequestWithTests: value: model_id: c82dd02c-4870-4907-8fcb-593a876cf05b meta: model: request action: import data: collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 method: POST headers: - key: Host value: postman-echo.com - key: user-agent value: curl/7.88.1 - key: accept value: '*/*' - key: content-type value: application/json - key: content-length value: '22' events: - listen: test script: id: a8608e1a-ce4b-4129-8c89-930d26ae0f6a exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' type: text/javascript - listen: prerequest script: id: 5b4bb273-5878-4bd7-a296-94a256783a66 exec: - '' type: text/javascript dataMode: raw url: https://postman-echo.com/post name: Example POST Request owner: '12345678' folder: null responses_order: [] id: c82dd02c-4870-4907-8fcb-593a876cf05b lastUpdatedBy: '12345678' headerData: [] createdAt: '2023-09-07T13:35:33.691Z' updatedAt: '2023-09-07T13:35:33.691Z' rawModeData: null dataOptions: raw: language: json responses: [] revision: 32456382272 collectionRequest400ErrorBadRequest: value: error: name: instanceFoundError message: This request already exists in the database. details: model: request model_id: c82dd02c-4870-4907-8fcb-593a876cf05b owner: '12345678' collectionRequest400ErrorChangeParentError: value: error: name: changeParentError message: You can't update the parent. Use transfer instead. details: server: model: collection model_id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 request: model: collection model_id: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 collectionRequest401ErrorUnauthorized: value: error: name: Unauthorized message: Unauthorized details: model: request model_id: c82dd02c-4870-4907-8fcb-593a876cf05b owner: '12345678' createCollectionResponse: value: name: Example POST Response description: This is an example POST response. url: https://postman-echo.com/post method: POST headers: - key: Host value: postman-echo.com - key: user-agent value: curl/7.88.1 - key: accept value: '*/*' - key: content-type value: application/json - key: content-length value: '22' dataMode: raw rawModeData: |- { "field": "Value" } dataOptions: raw: language: json createCollectionResponseGETResponse: value: model_id: cc364734-7dfd-4bfc-897d-be763dcdbb07 meta: model: response action: create data: request: c82dd02c-4870-4907-8fcb-593a876cf05b headers: - key: content-type value: application/json; charset=utf-8 - key: content-length value: '370' - key: etag value: W/"172-GDbDAS2r5X4Ypw2ia9AUhtyIyhk" - key: set-cookie value: sails.sid=s%3A23szD8Az12345Vs7dMzU4hjUHqqA1LeX.x8Jbnx4BEVHgzajknZdH%2BqxW7Pctx47m%2FlduU5Q4TAI; Path=/ HttpOnly name: Example GET Response text: | { "args": { "param": "value" }, "headers": { "x-forwarded-proto": "https", "x-forwarded-port": "443", "host": "postman-echo.com", "x-amzn-trace-id": "Root=1-64f9cd12-62f18f3a048796d345508073", "user-agent": "curl/7.88.1", "accept": "*/*", "content-type": "application/json" }, "url": "https://postman-echo.com/get?param=value" } requestObject: |- { "name": "Request", "description": "", "url": "https://postman-echo.com/get?param=value", "method": "GET", "headers": [ { "key": "Host", "value": "postman-echo.com" }, { "key": "user-agent", "value": "curl/7.88.1" }, { "key": "accept", "value": "*/*" }, { "key": "content-type", "value": "application/json" } ], "dataMode": "raw", "rawModeData": null, "dataOptions": { "raw": { "language": "json" } } } responseCode: code: 200 name: OK language: json id: cc364734-7dfd-4bfc-897d-be763dcdbb07 owner: '12345678' lastUpdatedBy: '12345678' createdAt: '2023-09-07T13:33:18.700Z' updatedAt: '2023-09-07T13:33:18.700Z' revision: 32456338262 createCollectionResponsePOSTResponse: value: model_id: cc364734-7dfd-4bfc-897d-be763dcdbb07 meta: model: response action: create data: request: c82dd02c-4870-4907-8fcb-593a876cf05b responseCode: code: 200 name: OK requestObject: |- { "name": "Request", "description": "", "url": "https://postman-echo.com/post", "method": "POST", "headers": [ { "key": "Host", "value": "postman-echo.com" }, { "key": "user-agent", "value": "curl/7.88.1" }, { "key": "accept", "value": "*/*" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "22" } ], "dataMode": "raw", "rawModeData": null, "dataOptions": { "raw": { "language": "json" } } } text: | { "args": {}, "data": { "field": "Value" }, "files": {}, "form": {}, "headers": { "x-forwarded-proto": "https", "x-forwarded-port": "443", "host": "postman-echo.com", "x-amzn-trace-id": "Root=1-71bdd0e4-2ad8-45ab-be3c-3dde999711a6", "content-length": "22", "user-agent": "curl/7.88.1", "accept": "*/*", "content-type": "application/json" }, "json": { "field": "Value" }, "url": "https://postman-echo.com/post" } name: POST response language: json headers: - key: date value: Thu, 07 Sep 2023 12:41:59 GMT - key: content-type value: application/json; charset=utf-8 - key: content-length value: '468' - key: etag value: W/"1d4-JuAIw8ssoFCtGzk/UwITxaiSbrc" - key: set-cookie value: sails.sid=s%3A23szD8Az12345Vs7dMzU4hjUHqqA1LeX.x8Jbnx4BEVHgzajknZdH%2BqxW7Pctx47m%2FlduU5Q4TAI; Path=/ HttpOnly id: cc364734-7dfd-4bfc-897d-be763dcdbb07 owner: '12345678' lastUpdatedBy: '12345678' createdAt: '2023-09-07T13:35:34.817Z' updatedAt: '2023-09-07T13:35:34.817Z' revision: 32456382761 collectionResponse400ErrorBadRequest: value: error: name: instanceFoundError message: This response already exists in the database. details: model: response model_id: cc364734-7dfd-4bfc-897d-be763dcdbb07 owner: '12345678' collectionResponse400ErrorChangeParentError: value: error: name: changeParentError message: You can't update the parent. Use transfer instead. details: server: model: request model_id: d35874f0-f7b3-4625-9096-2b2415444185 request: model: request model_id: e12d2aa6-85c8-4e6c-aad0-1adcfe05c958 collectionResponse401ErrorUnauthorized: value: error: name: Unauthorized message: Unauthorized details: model: response model_id: cc364734-7dfd-4bfc-897d-be763dcdbb07 owner: '12345678' getCollectionRolesSuccessfulResponse: value: group: - role: VIEWER id: 321 team: - role: EDITOR id: 123 user: - role: VIEWER id: 12345678 - role: EDITOR id: 87654321 collection404ErrorInstanceNotFound: value: title: We could not find the collection you are looking for type: instanceNotFoundError updateCollectionRoles: value: roles: - op: update path: /user value: - id: 12345678 role: EDITOR - id: 87654321 role: VIEWER - op: update path: /team value: - id: 123 role: VIEWER - id: 543 role: VIEWER - op: update path: /group value: - id: 12345 role: EDITOR - id: 123 role: EDITOR collectionRoles400ErrorMissingProperty: value: type: https://api.postman.com/problems/bad-request title: 'Missing properties: ''path''' detail: 'PATCH request body for ''/collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/roles/roles'' failed to validate schema. Location: /properties/roles/items/required' status: 400 getSourceCollectionStatusSuccessfulResponse: value: collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2: isSourceAhead: false forkCollection400ErrorNotForked: value: collection: name: badRequest message: The collection is not a forked collection. getCollectionFolderSuccessfulResponse: value: model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa meta: model: folder populate: false changeset: false action: find data: owner: '12345678' collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 folder: null id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa name: Test Folder description: This is a test collection folder. variables: null auth: type: apikey apikey: - key: value value: XXX - key: key value: x-api-key events: null order: - 81b49e05-0b87-4ca4-ac8c-091aaedafea3 - 929acf24-4234-45e1-59cf-dc2b27ea7603 - 3cfc2ac8-00a9-47d2-415d-049773f23268 folders_order: - 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa - 5c341de9-5751-461f-b7bd-af86bbae740c createdAt: '2022-08-29T16:49:19.964Z' updatedAt: '2022-08-29T16:49:19.964Z' getCollectionFolderResponseWithPopulateParameter: value: model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa meta: model: folder populate: true changeset: false action: find data: owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32546182786 collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 folder: null id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa name: Test Folder description: This is a test collection folder. variables: null auth: type: apikey apikey: - key: value value: XXX - key: key value: x-api-key events: null order: - 81b49e05-0b87-4ca4-ac8c-091aaedafea3 - 929acf24-4234-45e1-59cf-dc2b27ea7603 - 3cfc2ac8-00a9-47d2-415d-049773f23268 folders_order: - 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa - 5c341de9-5751-461f-b7bd-af86bbae740c createdAt: '2022-08-29T16:49:19.964Z' updatedAt: '2022-08-29T16:49:19.964Z' folders: - owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32588211132 collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 folder: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa id: 5c341de9-5751-461f-b7bd-af86bbae740c name: Test Folder description: This is a test collection folder. variables: null auth: null events: null order: - d924b1a5-6cf7-4dcf-a326-37dc9b91e295 - f0dd54db-8ad7-4b32-9e0b-5a0b5b52f78b folders_order: [] createdAt: '2023-09-13T21:56:35.000Z' updatedAt: '2023-09-15T16:26:54.000Z' - owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32588208043 collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 folder: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa name: Test Folder 2 description: This is another test collection folder. variables: null auth: null events: null order: - 6e5b9306-9e22-4d27-8a70-50692c19ad75 folders_order: [] createdAt: '2023-09-13T21:54:44.000Z' updatedAt: '2023-09-15T16:26:42.000Z' requests: - owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32545633807 folder: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 id: 3ac0e7be-86d9-443b-895d-2c2d959942d7 name: Test A dataMode: raw data: null auth: null events: null rawModeData: |- { "name": "Test", "description": "This is a test." } descriptionFormat: null description: null variables: null headers: '' method: PUT pathVariables: {} url: http://postman-echo.com/v1/request preRequestScript: null tests: null currentHelper: null helperAttributes: null queryParams: [] headerData: [] pathVariableData: [] protocolProfileBehavior: disableBodyPruning: true dataDisabled: false responses_order: - 6d9ec96b-1fec-4455-a9cc-f50d6ceb4997 createdAt: '2022-10-05T13:16:49.000Z' updatedAt: '2023-09-13T14:08:04.000Z' dataOptions: raw: language: json responses: - owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32545778004 request: 3ac0e7be-86d9-443b-895d-2c2d959942d7 id: 6d9ec96b-1fec-4455-a9cc-f50d6ceb4997 name: Test B status: null responseCode: code: 200 name: OK time: null headers: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookies: null mime: null text: |- { "id": "1234", "user": "test-user" } language: json rawDataType: null requestObject: '{"data":null,"dataMode":"raw","dataOptions":{"raw":{"language":"json"}},"headerData":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"method":"PUT","pathVariableData":[],"queryParams":[],"url":"https://postman-echo.com/v1/request","headers":"Content-Type: application/json\n","pathVariables":{},"protocolProfileBehavior":{"disableBodyPruning":true},"rawModeData":"{\n \"firstName\": \"Test\",\n \"lastName\": \"User\"\n}","graphqlModeData":{}}' createdAt: '2023-09-12T15:20:20.000Z' updatedAt: '2023-09-13T14:13:44.000Z' - owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32546060484 folder: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 id: 929acf24-4234-45e1-59cf-dc2b27ea7603 name: Test B dataMode: raw data: null auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: api-key type: string events: - listen: test script: id: a8608e1a-ce4b-4129-8c89-930d26ae0f6a exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' type: text/javascript - listen: prerequest script: id: 5b4bb273-5878-4bd7-a296-94a256783a66 exec: - '' type: text/javascript rawModeData: |- { "name": "Test API", "description": "This is a test API." } descriptionFormat: null description: null variables: null headers: '' method: POST pathVariables: {} url: https://postman-echo.com/v1/post preRequestScript: null tests: |- pm.test("Status code is 200", function () { pm.response.to.have.status(200); }); currentHelper: apikeyAuth helperAttributes: '{"id":"apikey","key":"api-key","value":"XXX"}' queryParams: [] headerData: [] pathVariableData: [] protocolProfileBehavior: disableBodyPruning: true dataDisabled: false responses_order: - 3c36a13f-2785-49ff-a969-1520769b28f5 createdAt: '2023-09-07T14:03:52.000Z' updatedAt: '2023-09-13T14:26:58.000Z' dataOptions: raw: language: json responses: - owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32546199268 request: 929acf24-4234-45e1-59cf-dc2b27ea7603 id: 3c36a13f-2785-49ff-a969-1520769b28f5 name: Successful Response status: null responseCode: null time: null headers: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookies: null mime: null text: |- { "id": "test-api", "name": "Test API", "description": "This is a test API.", "is_public": false, "created_at": "2022-01-28T11:50:56.000Z", "updated_at": "2022-01-28T11:50:56.000Z", "performance": { "collection": "12ece9e1-2abf-4edc-8e34-de66e74114d2", "environment": "12ece9e1-2abf-4edc-8e34-de66e74114d2" } } language: json rawDataType: null requestObject: '{"data":null,"dataMode":"raw","dataOptions":{"raw":{"language":"json"}},"headerData":[],"method":"POST","pathVariableData":[],"queryParams":[],"url":"https://postman-echo.com/post","headers":"","pathVariables":{},"protocolProfileBehavior":{"disableBodyPruning":true},"rawModeData":"{\n \"name\": \"Test API\",\n \"description\": \"This is a test API.\"\n}","graphqlModeData":{}}' createdAt: '2023-09-12T15:21:55.000Z' updatedAt: '2023-09-13T14:33:26.000Z' - owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32545561759 folder: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 id: fb620884-9745-4244-b875-6c33a8acc771 name: Test A dataMode: raw data: null auth: type: bearer bearer: - key: token value: TEST type: string events: - listen: test script: id: b12101c5-fe85-4722-adf0-a1e900eab708 exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' type: text/javascript - listen: prerequest script: id: 7b34bf6b-f440-4768-a486-4ce96e997cb7 exec: - pm.sendRequest("https://postman-echo.com/get", function (err, response) { - ' console.log(response.json());' - '});' type: text/javascript rawModeData: '' descriptionFormat: markdown description: This is a test API. variables: null headers: | Accept: application/vnd.example.v1+json method: GET pathVariables: {} url: https://postman-echo.com/v1/request?id={{id}} preRequestScript: |- pm.sendRequest("https://postman-echo.com/get", function (err, response) { console.log(response.json()); }); tests: |- pm.test("Status code is 200", function () { pm.response.to.have.status(200); }); currentHelper: bearerAuth helperAttributes: '{"id":"bearer","token":"TEST"}' queryParams: - key: id value: '{{id}}' equals: true description: The API's ID. enabled: true headerData: - key: Accept value: application/vnd.example.v1+json description: null type: text enabled: true pathVariableData: [] protocolProfileBehavior: disableBodyPruning: true dataDisabled: false responses_order: - ee4ab273-1f36-f8de-adfc-02ad1cd126dc - 33745d7c-0cb3-4097-b038-6d9a08886ae1 createdAt: '2022-10-05T13:09:24.000Z' updatedAt: '2023-09-13T14:04:37.000Z' dataOptions: raw: language: json responses: - owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32545559961 request: fb620884-9745-4244-b875-6c33a8acc771 id: 33745d7c-0cb3-4097-b038-6d9a08886ae1 name: Not Found status: null responseCode: name: Not Found code: 404 time: null headers: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookies: null mime: null text: |- { "title": "Not Found", "detail": "Requested API does not exist", "type": "about:blank" } language: json rawDataType: null requestObject: '{"data":null,"dataMode":"raw","dataOptions":{"raw":{"language":"json"}},"headerData":[{"key":"Accept","value":"application/vnd.example.v1+json","description":"","type":"text","enabled":true}],"method":"GET","pathVariableData":[],"queryParams":[{"key":"id","value":"test-api","equals":true,"description":null,"enabled":true}],"url":"https://postman-echo.com/v1/request?id=test-api","headers":"Accept: application/vnd.example.v1+json\n","pathVariables":{},"protocolProfileBehavior":{"disableBodyPruning":true},"rawModeData":"","graphqlModeData":{}}' createdAt: '2023-08-22T12:53:12.000Z' updatedAt: '2023-09-13T14:04:32.000Z' - owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32545561807 request: fb620884-9745-4244-b875-6c33a8acc771 id: ee4ab273-1f36-f8de-adfc-02ad1cd126dc name: Successful Response status: null responseCode: code: 200 name: OK time: null headers: - key: date value: Thu, 07 Sep 2023 12:41:59 GMT - key: content-type value: application/json; charset=utf-8 - key: content-length value: '468' - key: etag value: W/"1d4-JuAIw8ssoFCtGzk/UwITxaiSbrc" - key: set-cookie value: sails.sid=s%3A6p_NXpI3OZeGE35bI6i5Uq3XgHHxcsdJ.dQVpBE%2BJ9wHWainkqe6F6dkdv7UKoshSZY7sdZ5sbzo; Path=/ HttpOnly cookies: null mime: null text: | { "args": {}, "data": { "field": "Value" }, "files": {}, "form": {}, "headers": { "x-forwarded-proto": "https", "x-forwarded-port": "443", "host": "postman-echo.com", "x-amzn-trace-id": "Root=1-64f9c517-36db304817c774d740619baa", "content-length": "22", "user-agent": "curl/7.88.1", "accept": "*/*", "content-type": "application/json" }, "json": { "field": "Value" }, "url": "https://postman-echo.com/post" } language: json rawDataType: null requestObject: |- { "name": "Request", "description": "", "url": "https://postman-echo.com/post", "method": "POST", "headers": [ { "key": "Host", "value": "postman-echo.com" }, { "key": "user-agent", "value": "curl/7.88.1" }, { "key": "accept", "value": "*/*" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "22" } ], "dataMode": "raw", "rawModeData": "{\n \"field\": \"Value\"\n}", "dataOptions": { "raw": { "language": "json" } } } createdAt: '2023-09-12T18:34:27.000Z' updatedAt: '2023-09-13T14:04:37.000Z' - owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32545799957 folder: 35cda0a4-23fb-4add-a352-fc1b0f96fbd1 collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 id: b0e4627a-f359-415e-8f2e-4a86b2506fb5 name: Test E dataMode: raw data: null auth: type: bearer bearer: - key: token value: TEST type: string events: null rawModeData: |- { "username": "test-user", "firstName": "Test", "lastName": "User" } descriptionFormat: null description: This is an example PATCH request. variables: null headers: '' method: PATCH pathVariables: {} url: https://postman-echo.com/get?id={{id}} preRequestScript: null tests: null currentHelper: bearerAuth helperAttributes: '{"id":"bearer","token":"TEST"}' queryParams: - key: id value: '{{id}}' equals: true description: The user's ID. enabled: true headerData: [] pathVariableData: [] protocolProfileBehavior: disableBodyPruning: true dataDisabled: false responses_order: - d47ba091-90b3-4f3a-9e33-09000784bc8f createdAt: '2023-09-13T14:05:22.000Z' updatedAt: '2023-09-13T14:14:41.000Z' dataOptions: raw: language: json responses: - owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32545769906 request: b0e4627a-f359-415e-8f2e-4a86b2506fb5 id: d47ba091-90b3-4f3a-9e33-09000784bc8f name: Successful Response status: null responseCode: code: 200 name: OK time: null headers: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookies: null mime: null text: |- { "id": "1234", "user": "test-user" } language: json rawDataType: null requestObject: '{"data":null,"dataMode":"raw","dataOptions":{"raw":{"language":"json"}},"headerData":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"method":"GET","pathVariableData":[],"queryParams":[{"key":"id","value":"1234","equals":true,"description":"Optional. The user''s ID.","enabled":true}],"url":"https://postman-echo.com/get?id=1234","headers":"Content-Type: application/json\n","pathVariables":{},"protocolProfileBehavior":{"disableBodyPruning":true},"rawModeData":"{\n \"firstName\": \"Test\",\n \"lastName\": \"User\"\n}","graphqlModeData":{}}' createdAt: '2023-09-13T14:05:22.000Z' updatedAt: '2023-09-13T14:13:21.000Z' - owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32546157840 folder: 35cda0a4-23fb-4add-a352-fc1b0f96fbd1 collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 id: f9805781-69c1-4332-be32-bda89eb765aa name: Test D dataMode: null data: null auth: type: apikey apikey: - key: value value: XXX type: string - key: key value: api-key type: string events: - listen: prerequest script: id: 120f2410-edbf-45b2-a21e-1e76335a3c71 exec: - pm.sendRequest("https://postman-echo.com/get", function (err, response) { - ' console.log(response.json());' - '});' type: text/javascript - listen: test script: id: 3300c158-1bdd-4d99-a532-191a037a4d4a exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' type: text/javascript rawModeData: null descriptionFormat: null description: This is an example GET request. variables: null headers: '' method: GET pathVariables: {} url: https://postman-echo.com/get?id={{id}} preRequestScript: |- pm.sendRequest("https://postman-echo.com/get", function (err, response) { console.log(response.json()); }); tests: |- pm.test("Status code is 200", function () { pm.response.to.have.status(200); }); currentHelper: apikeyAuth helperAttributes: '{"id":"apikey","key":"api-key","value":"XXX"}' queryParams: - key: id value: '{{id}}' equals: true description: Optional. The user's ID. enabled: true headerData: [] pathVariableData: [] protocolProfileBehavior: disableBodyPruning: true dataDisabled: false responses_order: - e4eda8a5-eef0-4fb7-b2c6-dd5bd3d67dd3 createdAt: '2023-08-22T12:52:01.000Z' updatedAt: '2023-09-13T14:31:25.000Z' responses: - owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32545767296 request: f9805781-69c1-4332-be32-bda89eb765aa id: e4eda8a5-eef0-4fb7-b2c6-dd5bd3d67dd3 name: Successful Response status: null responseCode: code: 200 name: OK time: null headers: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookies: null mime: null text: |- { "id": "1234", "user": "test-user", "firstName": "Test", "lastName": "User" } language: json rawDataType: null requestObject: '{"data":null,"dataMode":null,"dataOptions":{"raw":{"language":"json"}},"headerData":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"method":"GET","pathVariableData":[],"queryParams":[{"key":"id","value":"1234","equals":true,"description":"Optional. The user''s ID.","enabled":true}],"url":"https://postman-echo.com/get?id=1234","headers":"Content-Type: application/json\n","pathVariables":{},"protocolProfileBehavior":{"disableBodyPruning":true}}' createdAt: '2023-09-07T14:39:52.000Z' updatedAt: '2023-09-13T14:13:08.000Z' getCollectionFolderResponseWithIdsParameter: value: model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa meta: model: folder action: find populate: false changeset: false data: owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 24994132707 collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 folder: null id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa name: Test Folder description: This is a test collection folder. variables: null auth: type: apikey apikey: - key: value value: XXX - key: key value: x-api-key events: null order: - 81b49e05-0b87-4ca4-ac8c-091aaedafea3 - 929acf24-4234-45e1-59cf-dc2b27ea7603 - 3cfc2ac8-00a9-47d2-415d-049773f23268 createdAt: '2022-08-29T16:49:19.964Z' updatedAt: '2022-08-29T16:49:19.964Z' folders_order: - 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa - 5c341de9-5751-461f-b7bd-af86bbae740c getCollectionFolderResponseWithUidParameter: value: model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa meta: model: folder populate: false changeset: false action: find data: owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 24994132707 collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 folder: null id: 12345678-65a99e60-8e0a-4b6e-b79c-7d8264cc5caa name: Test Folder description: This is a test collection folder. variables: null auth: type: apikey apikey: - key: value value: XXX - key: key value: x-api-key events: null order: - 12345678-81b49e05-0b87-4ca4-ac8c-091aaedafea3 - 12345678-929acf24-4234-45e1-59cf-dc2b27ea7603 - 12345678-3cfc2ac8-00a9-47d2-415d-049773f23268 folders_order: - 12345678-65a99e60-8e0a-4b6e-b79c-7d8264cc5caa - 12345678-5c341de9-5751-461f-b7bd-af86bbae740c createdAt: '2022-08-29T16:49:19.964Z' updatedAt: '2022-08-29T16:49:19.964Z' collectionFolder404ErrorNotFound: value: error: name: instanceNotFoundError message: We could not find the folder you are looking for details: model: folder model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa owner: '12345678' updateCollectionFolderSuccessfulResponse: value: data: id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa auth: null name: Test Folder order: [] owner: '12345678' events: null folder: null updatedAt: '2022-08-29T16:49:19.964Z' createdAt: '2022-08-29T16:49:19.964Z' variables: null collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 description: This is a test folder. lastRevision: 24977100955 folders_order: [] lastUpdatedBy: '12345678' meta: model: folder action: update model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa revision: 24977103385 updateCollectionFolderSortRequestsInFolder: value: data: order: - 66c7fe01-2c7e-4149-9de1-1143592f7bad - 3def345e-b4b3-4319-8e2c-65d2630c0345 - c089bf09-c679-4116-9654-9a561276634d - eb82f2b7-0478-4068-8e8a-c277e25ba0d3 id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa auth: null name: Test Folder owner: '12345678' events: null folder: null updatedAt: '2022-08-29T16:49:19.964Z' createdAt: '2022-08-29T16:49:19.964Z' variables: null collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 description: This is a test folder. lastRevision: 24977100955 folders_order: [] lastUpdatedBy: '12345678' meta: model: folder action: update model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa revision: 24977103385 updateCollectionFolderSortFoldersInFolder: value: data: folders_order: - b73b4c0c-881b-47e6-8887-6dabab1fd2d1 - abcc80b2-8a1c-45e5-ab1b-becc385b4dbd id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa auth: null name: Test Folder order: [] owner: '12345678' events: null folder: null updatedAt: '2022-08-29T16:49:19.964Z' createdAt: '2022-08-29T16:49:19.964Z' variables: null collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 description: This is a test folder. lastRevision: 24977100955 lastUpdatedBy: '12345678' meta: model: folder action: update model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa revision: 24977103385 deleteCollectionFolderSuccessfulResponse: value: model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa meta: model: folder action: destroy data: id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa owner: '12345678' revision: 24994562696 getCollectionRequestGETRequest: value: model_id: c82dd02c-4870-4907-8fcb-593a876cf05b meta: model: request populate: false changeset: false action: find data: owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32206434799 folder: null collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 id: c82dd02c-4870-4907-8fcb-593a876cf05b name: Example GET Request dataMode: null data: null auth: null events: null rawModeData: null descriptionFormat: null description: This is an example GET request. variables: null headers: null method: GET pathVariables: {} url: https://postman-echo.com/get preRequestScript: null tests: var data = JSON.parse(responseBody); currentHelper: null helperAttributes: null queryParams: - key: id value: '{{id}}' equals: true description: Optional. The user's ID. enabled: true headerData: [] pathVariableData: [] protocolProfileBehavior: disableBodyPruning: true dataDisabled: false responses_order: [] createdAt: '2023-08-22T12:52:01.000Z' updatedAt: '2023-08-22T12:52:11.000Z' getCollectionRequestPOSTRequest: value: model_id: c82dd02c-4870-4907-8fcb-593a876cf05b meta: model: request populate: false changeset: false action: find data: owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 24994863800 folder: null collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 id: c82dd02c-4870-4907-8fcb-593a876cf05b name: Example POST request dataMode: raw data: null auth: null events: null rawModeData: |- { "field": "Value" } descriptionFormat: null description: null variables: null headers: '' method: POST pathVariables: {} url: https://postman-echo.com/post preRequestScript: null tests: null currentHelper: null helperAttributes: null queryParams: [] headerData: [] pathVariableData: [] protocolProfileBehavior: disableBodyPruning: true dataDisabled: false responses_order: - cc364734-7dfd-4bfc-897d-be763dcdbb07 createdAt: '2023-09-01T07:29:17.000Z' updatedAt: '2023-09-01T07:36:30.000Z' dataOptions: raw: language: json getCollectionRequestRequestWithInheritParentAuth: value: model_id: c82dd02c-4870-4907-8fcb-593a876cf05b meta: model: request populate: false changeset: false action: find data: owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 24994863800 folder: null collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 id: c82dd02c-4870-4907-8fcb-593a876cf05b name: Example POST request dataMode: params data: - enabled: true value: 3f14c9c7-e71c-4094-b90e-ac9edb232c2e type: text key: id - enabled: true value: 12ece9e1-2abf-4edc-8e34-de66e74114d2 type: text key: collection auth: type: bearer bearer: - key: token value: xxx type: string events: - listen: test script: type: text/javascript exec: - var data = JSON.parse(responseBody); rawModeData: null descriptionFormat: null description: This is an example POST request. variables: null headers: '' method: POST pathVariables: {} url: https://api.getpostman.com/v1/request preRequestScript: null tests: var data = JSON.parse(responseBody); currentHelper: bearerAuth helperAttributes: '{"id":"bearer","token":"xxx"}' queryParams: [] headerData: [] pathVariableData: [] protocolProfileBehavior: null dataDisabled: null responses_order: [] createdAt: '2022-08-29T16:49:19.964Z' updatedAt: '2022-08-29T16:49:19.964Z' dataOptions: params: null getCollectionRequestResponseWithPopulateParameter: value: model_id: fb620884-9745-4244-b875-6c33a8acc771 meta: model: request populate: true changeset: false action: find data: owner: '20891195' lastUpdatedBy: '20891195' lastRevision: 32545561759 folder: adb40f20-deec-4cc6-b1a2-a5591f469c60 collection: b75dfb85-9209-4212-8f3d-a9d5e28167e5 id: fb620884-9745-4244-b875-6c33a8acc771 name: Test A dataMode: raw data: null auth: type: bearer bearer: - key: token value: TEST type: string events: - listen: test script: id: b12101c5-fe85-4722-adf0-a1e900eab708 exec: - pm.test("Status code is 200", function () { - ' pm.response.to.have.status(200);' - '});' type: text/javascript - listen: prerequest script: id: 7b34bf6b-f440-4768-a486-4ce96e997cb7 exec: - pm.sendRequest("https://postman-echo.com/get", function (err, response) { - ' console.log(response.json());' - '});' type: text/javascript rawModeData: '' descriptionFormat: markdown description: This is a test API. variables: null headers: | Accept: application/vnd.example.v1+json method: GET pathVariables: {} url: https://postman-echo.com/v1/request?id={{id}} preRequestScript: |- pm.sendRequest("https://postman-echo.com/get", function (err, response) { console.log(response.json()); }); tests: |- pm.test("Status code is 200", function () { pm.response.to.have.status(200); }); currentHelper: bearerAuth helperAttributes: '{"id":"bearer","token":"TEST"}' queryParams: - key: id value: '{{id}}' equals: true description: The API's ID. enabled: true headerData: - key: Accept value: application/vnd.example.v1+json description: null type: text enabled: true pathVariableData: [] protocolProfileBehavior: disableBodyPruning: true dataDisabled: false responses_order: - ee4ab273-1f36-f8de-adfc-02ad1cd126dc createdAt: '2022-10-05T13:09:24.000Z' updatedAt: '2023-09-13T14:04:37.000Z' dataOptions: raw: language: json responses: - owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32545561807 request: fb620884-9745-4244-b875-6c33a8acc771 id: ee4ab273-1f36-f8de-adfc-02ad1cd126dc name: Successful Response status: null responseCode: code: 200 name: OK time: null headers: - key: date value: Thu, 07 Sep 2023 12:41:59 GMT - key: content-type value: application/json; charset=utf-8 - key: content-length value: '468' - key: etag value: W/"1d4-JuAIw8ssoFCtGzk/UwITxaiSbrc" - key: set-cookie value: sails.sid=s%3A6p_NXpI3OZeGE35bI6i5Uq3XgHHxcsdJ.dQVpBE%2BJ9wHWainkqe6F6dkdv7UKoshSZY7sdZ5sbzo; Path=/ HttpOnly cookies: null mime: null text: | { "args": {}, "data": { "field": "Value" }, "files": {}, "form": {}, "headers": { "x-forwarded-proto": "https", "x-forwarded-port": "443", "host": "postman-echo.com", "x-amzn-trace-id": "Root=1-64f9c517-36db304817c774d740619baa", "content-length": "22", "user-agent": "curl/7.88.1", "accept": "*/*", "content-type": "application/json" }, "json": { "field": "Value" }, "url": "https://postman-echo.com/post" } language: json rawDataType: null requestObject: |- { "name": "Request", "description": "", "url": "https://postman-echo.com/post", "method": "POST", "headers": [ { "key": "Host", "value": "postman-echo.com" }, { "key": "user-agent", "value": "curl/7.88.1" }, { "key": "accept", "value": "*/*" }, { "key": "content-type", "value": "application/json" }, { "key": "content-length", "value": "22" } ], "dataMode": "raw", "rawModeData": "{\n \"field\": \"Value\"\n}", "dataOptions": { "raw": { "language": "json" } } } createdAt: '2023-09-12T18:34:27.000Z' updatedAt: '2023-09-13T14:04:37.000Z' getCollectionRequestResponseWithIdsParameter: value: model_id: c82dd02c-4870-4907-8fcb-593a876cf05b meta: model: request populate: false changeset: false action: find data: owner: '12345678' folder: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 id: c82dd02c-4870-4907-8fcb-593a876cf05b responses_order: - 773e5707-4a56-45de-b31d-c68a6f74d1c6 - 3ce18318-9d74-4805-956e-7fda0b830bea getCollectionRequestResponseWithUidParameter: value: model_id: c82dd02c-4870-4907-8fcb-593a876cf05b meta: model: request populate: false changeset: false action: find data: owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32206434799 folder: null collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 id: 12345678-c82dd02c-4870-4907-8fcb-593a876cf05b name: Example GET Request dataMode: null data: null auth: null events: null rawModeData: null descriptionFormat: null description: This is an example GET request. variables: null headers: null method: GET pathVariables: {} url: https://postman-echo.com/get preRequestScript: null tests: var data = JSON.parse(responseBody); currentHelper: null helperAttributes: null queryParams: - key: id value: '{{id}}' equals: true description: Optional. The user's ID. enabled: true headerData: [] pathVariableData: [] protocolProfileBehavior: disableBodyPruning: true dataDisabled: false responses_order: [] createdAt: '2023-08-22T12:52:01.000Z' updatedAt: '2023-08-22T12:52:11.000Z' collectionRequest404ErrorInstanceFoundError: value: error: name: instanceFoundError message: We could not find the request you are looking for details: model: request model_id: c82dd02c-4870-4907-8fcb-593a876cf05b owner: '12345678' collectionRequest404ErrorInstanceNotFoundError: value: error: name: instanceNotFoundError message: We could not find the request you are looking for details: model: request model_id: c82dd02c-4870-4907-8fcb-593a876cf05b owner: '12345678' updateCollectionRequest: value: oauth: noauth currentHelper: null helperAttributes: null owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32368133476 folder: null collection: c05fb60e-bb28-4e7b-9cf7-55ada6ab320c name: Example POST Request dataMode: raw data: null events: null rawModeData: |- { "field": "Value" } descriptionFormat: null description: This is an example POST request. variables: null headers: null method: POST pathVariables: null url: https://postman-echo.com/post preRequestScript: null tests: null queryParams: [] headerData: [] pathVariableData: [] protocolProfileBehavior: null dataDisabled: false responses_order: [] createdAt: '2023-09-01T07:59:25.000Z' updatedAt: '2023-09-01T09:29:54.000Z' dataOptions: raw: language: json updateCollectionRequestSuccessfulResponse: value: model_id: c82dd02c-4870-4907-8fcb-593a876cf05b meta: model: request action: update data: id: c82dd02c-4870-4907-8fcb-593a876cf05b name: Example POST Request dataMode: raw data: null auth: noauth events: null rawModeData: |- { "field": "Value" } descriptionFormat: null description: This is an example POST request. variables: null headers: null method: POST pathVariables: null url: https://postman-echo.com/post preRequestScript: null tests: null currentHelper: null helperAttributes: null queryParams: [] headerData: [] pathVariableData: [] protocolProfileBehavior: null dataDisabled: false responses_order: [] createdAt: '2023-09-01T07:59:25.000Z' updatedAt: '2023-09-08T12:30:29.000Z' owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32473087936 folder: null collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 dataOptions: raw: language: json revision: 32473098909 updateCollectionRequestUpdateToInheritParentAuth: value: model_id: c82dd02c-4870-4907-8fcb-593a876cf05b meta: model: request action: update data: id: c82dd02c-4870-4907-8fcb-593a876cf05b name: Example POST Request dataMode: params data: - enabled: true value: 3f14c9c7-e71c-4094-b90e-ac9edb232c2e type: text key: id - enabled: true value: 12ece9e1-2abf-4edc-8e34-de66e74114d2 type: text key: collection auth: null events: - listen: test script: type: text/javascript exec: - var data = JSON.parse(responseBody); rawModeData: |- { "field": "Value" } descriptionFormat: null description: This is an example POST request. variables: null headers: '' method: POST pathVariables: {} url: https://postman-echo.com/post preRequestScript: null tests: var data = JSON.parse(responseBody); currentHelper: null helperAttributes: null queryParams: [] headerData: [] pathVariableData: [] protocolProfileBehavior: null dataDisabled: false responses_order: [] createdAt: '2022-08-29T16:49:19.964Z' updatedAt: '2022-08-29T16:49:19.964Z' owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 24994863800 folder: null collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 dataOptions: raw: language: json revision: 24994954828 updateCollectionRequestDisableQueryParams: value: model_id: c82dd02c-4870-4907-8fcb-593a876cf05b meta: model: request action: update data: id: c82dd02c-4870-4907-8fcb-593a876cf05b name: Example POST Request dataMode: params data: - enabled: true value: 3f14c9c7-e71c-4094-b90e-ac9edb232c2e type: text key: id - enabled: true value: 12ece9e1-2abf-4edc-8e34-de66e74114d2 type: text key: collection auth: null events: - listen: test script: type: text/javascript exec: - var data = JSON.parse(responseBody); rawModeData: |- { "field": "Value" } descriptionFormat: null description: This is an example POST request. variables: null headers: '' method: POST pathVariables: {} url: https://postman-echo.com/post preRequestScript: null tests: var data = JSON.parse(responseBody); currentHelper: null helperAttributes: null queryParams: [] headerData: [] pathVariableData: [] protocolProfileBehavior: null dataDisabled: false responses_order: [] createdAt: '2022-08-29T16:49:19.964Z' updatedAt: '2022-08-29T16:49:19.964Z' owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 24994863800 folder: null collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2 dataOptions: raw: language: json revision: 24994954828 deleteCollectionRequestSuccessfulResponse: value: model_id: c82dd02c-4870-4907-8fcb-593a876cf05b meta: model: request action: destroy data: id: c82dd02c-4870-4907-8fcb-593a876cf05b owner: '12345678' revision: 24995158577 getCollectionResponseGETResponse: value: model_id: cc364734-7dfd-4bfc-897d-be763dcdbb07 meta: model: response populate: false changeset: false action: find data: owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32528384460 request: c82dd02c-4870-4907-8fcb-593a876cf05b id: cc364734-7dfd-4bfc-897d-be763dcdbb07 name: Not Found status: null responseCode: code: 404 name: Not Found time: null headers: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookies: null mime: null text: |- { "title": "Not Found", "detail": "Requested API does not exist", "type": "about:blank" } language: json rawDataType: null requestObject: '{"data":null,"dataMode":"raw","dataOptions":{"raw":{"language":"json"}},"headerData":[{"key":"Accept","value":"application/vnd.example.v1+json","description":"","type":"text","enabled":true}],"method":"GET","pathVariableData":[],"queryParams":[{"key":"id","value":"test-api","equals":true,"description":null,"enabled":true}],"url":"http://api.getpostman.com/v1/request?id=test-api","headers":"Accept: application/vnd.example.v1+json\n","pathVariables":{},"protocolProfileBehavior":{"disableBodyPruning":true},"rawModeData":"","graphqlModeData":{}}' createdAt: '2023-08-22T12:53:12.000Z' updatedAt: '2023-09-12T18:23:42.000Z' getCollectionResponsePOSTResponse: value: model_id: cc364734-7dfd-4bfc-897d-be763dcdbb07 meta: model: response populate: false changeset: false action: find data: owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32366010334 request: c82dd02c-4870-4907-8fcb-593a876cf05b id: cc364734-7dfd-4bfc-897d-be763dcdbb07 name: Example POST response status: null responseCode: code: 200 name: OK time: null headers: - key: Date value: Fri, 01 Sep 2023 07:36:18 GMT - key: Content-Type value: application/json; charset=utf-8 - key: Content-Length value: '607' - key: Connection value: keep-alive - key: ETag value: W/"25f-fXeI1ntSNPOD7sOol6cMrRL0DYk" - key: set-cookie value: sails.sid=s%3A4o6OiKlJvAK5dTEKRnH-ZMOU7jHTwNB-.owD6JTABpH6H6rH8gY09Z7ATvkr2elxL4iGyWnJkBPg; Path=/ HttpOnly cookies: null mime: null text: |- { "args": {}, "data": { "field": "Value" }, "files": {}, "form": {}, "headers": { "x-forwarded-proto": "https", "x-forwarded-port": "123", "host": "postman-echo.com", "x-amzn-trace-id": "Root=1-71bdd0e4-2ad8-45ab-be3c-3dde999711a6", "content-length": "24", "content-type": "application/json", "x-api-key": "xxx", "user-agent": "PostmanRuntime/7.32.3", "accept": "*/*", "postman-token": "XXXX", "accept-encoding": "gzip, deflate, br" }, "json": { "field": "Value" }, "url": "https://postman-echo.com/post" } language: json rawDataType: null requestObject: '{"data":null,"dataMode":"raw","dataOptions":{"raw":{"language":"json"}},"headerData":[],"method":"POST","pathVariableData":[],"queryParams":[],"url":"https://postman-echo.com/post","headers":"","pathVariables":{},"protocolProfileBehavior":{"disableBodyPruning":true},"rawModeData":"{\n \"field\": \"Value\"\n}","graphqlModeData":{}}' createdAt: '2023-09-12T15:21:55.000Z' updatedAt: '2023-09-12T18:27:57.000Z' getCollectionResponseResponseWithPopulateParameter: value: model_id: cc364734-7dfd-4bfc-897d-be763dcdbb07 meta: model: response populate: false changeset: false action: find data: owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32528384460 request: c82dd02c-4870-4907-8fcb-593a876cf05b id: cc364734-7dfd-4bfc-897d-be763dcdbb07 name: Not Found status: null responseCode: code: 404 name: Not Found time: null headers: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookies: null mime: null text: |- { "title": "Not Found", "detail": "Requested API does not exist", "type": "about:blank" } language: json rawDataType: null requestObject: '{"data":null,"dataMode":"raw","dataOptions":{"raw":{"language":"json"}},"headerData":[{"key":"Accept","value":"application/vnd.example.v1+json","description":"","type":"text","enabled":true}],"method":"GET","pathVariableData":[],"queryParams":[{"key":"id","value":"test-api","equals":true,"description":null,"enabled":true}],"url":"https://postman-echo.com/v1/request?id=test-api","headers":"Accept: application/vnd.example.v1+json\n","pathVariables":{},"protocolProfileBehavior":{"disableBodyPruning":true},"rawModeData":"","graphqlModeData":{}}' createdAt: '2023-08-22T12:53:12.000Z' updatedAt: '2023-09-12T18:23:42.000Z' getCollectionResponseResponseWithIdsParameter: value: model_id: cc364734-7dfd-4bfc-897d-be763dcdbb07 meta: model: response populate: false changeset: false action: find data: owner: '12345678' request: c82dd02c-4870-4907-8fcb-593a876cf05b id: cc364734-7dfd-4bfc-897d-be763dcdbb07 getCollectionResponseResponseWithUidParameter: value: model_id: cc364734-7dfd-4bfc-897d-be763dcdbb07 meta: model: response populate: false changeset: false action: find data: owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32528384460 request: 12345678-c82dd02c-4870-4907-8fcb-593a876cf05b id: 12345678-cc364734-7dfd-4bfc-897d-be763dcdbb07 name: Not Found status: null responseCode: code: 404 name: Not Found time: null headers: - key: Content-Type name: Content-Type value: application/json description: '' type: text cookies: null mime: null text: |- { "title": "Not Found", "detail": "Requested API does not exist", "type": "about:blank" } language: json rawDataType: null requestObject: '{"data":null,"dataMode":"raw","dataOptions":{"raw":{"language":"json"}},"headerData":[{"key":"Accept","value":"application/vnd.example.v1+json","description":"","type":"text","enabled":true}],"method":"GET","pathVariableData":[],"queryParams":[{"key":"id","value":"test-api","equals":true,"description":null,"enabled":true}],"url":"https://postman-echo.com/v1/request?id=test-api","headers":"Accept: application/vnd.example.v1+json\n","pathVariables":{},"protocolProfileBehavior":{"disableBodyPruning":true},"rawModeData":"","graphqlModeData":{}}' createdAt: '2023-08-22T12:53:12.000Z' updatedAt: '2023-09-12T18:23:42.000Z' collectionResponse404ErrorNotFound: value: error: name: instanceNotFoundError message: We could not find the response you are looking for details: model: response model_id: cc364734-7dfd-4bfc-897d-be763dcdbb07 owner: '12345678' collectionResponse404ErrorUnauthorized: value: error: name: Unauthorized message: Unauthorized details: model: response model_id: cc364734-7dfd-4bfc-897d-be763dcdbb07 owner: '12345678' updateCollectionResponse: value: owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32368133468 request: c82dd02c-4870-4907-8fcb-593a876cf05b name: Example Response status: null responseCode: code: 200 name: OK time: '50' headers: - key: Date value: Fri, 01 Sep 2023 07:36:18 GMT - key: Content-Type value: application/json; charset=utf-8 - key: Content-Length value: '607' - key: Connection value: keep-alive cookies: null mime: null text: |- { "args": {}, "data": { "field": "Value" }, "files": {}, "form": {}, "headers": { "x-forwarded-proto": "https", "x-forwarded-port": "443", "host": "postman-echo.com", "x-amzn-trace-id": "Root=1-64f9cd12-62f18f3a048796d345508073", "content-length": "24", "content-type": "application/json", "x-api-key": "xxx", "user-agent": "PostmanRuntime/7.32.3", "accept": "*/*", "postman-token": "XXX", "accept-encoding": "gzip, deflate, br" }, "json": { "field": "Value" }, "url": "https://postman-echo.com/post" } language: json rawDataType: null requestObject: '{"data":null,"dataMode":"raw","dataOptions":{"raw":{"language":"json"}},"headerData":[],"method":"POST","pathVariableData":[],"queryParams":[],"url":"https://postman-echo.com/post","headers":"","pathVariables":{},"protocolProfileBehavior":{"disableBodyPruning":true},"rawModeData":"{\n \"field\": \"Value\"\n}","graphqlModeData":{}}' createdAt: '2023-09-01T09:29:54.000Z' updatedAt: '2023-09-01T09:29:54.000Z' updateCollectionResponseSuccessfulResponse: value: model_id: c82dd02c-4870-4907-8fcb-593a876cf05b meta: model: response action: update data: id: c82dd02c-4870-4907-8fcb-593a876cf05b name: Example Response status: null responseCode: name: OK code: 200 time: '50' headers: - value: Fri, 01 Sep 2023 07:36:18 GMT key: Date - value: application/json; charset=utf-8 key: Content-Type - value: '607' key: Content-Length - value: keep-alive key: Connection cookies: null mime: null text: |- { "args": {}, "data": { "field": "Value" }, "files": {}, "form": {}, "headers": { "x-forwarded-proto": "https", "x-forwarded-port": "443", "host": "postman-echo.com", "x-amzn-trace-id": "Root=1-64f9cd12-62f18f3a048796d345508073", "content-length": "24", "content-type": "application/json", "x-api-key": "xxx", "user-agent": "PostmanRuntime/7.32.3", "accept": "*/*", "postman-token": "XXX", "accept-encoding": "gzip, deflate, br" }, "json": { "field": "Value" }, "url": "https://postman-echo.com/post" } language: json rawDataType: null requestObject: '{"data":null,"dataMode":"raw","dataOptions":{"raw":{"language":"json"}},"headerData":[],"method":"POST","pathVariableData":[],"queryParams":[],"url":"https://postman-echo.com/post","headers":"","pathVariables":{},"protocolProfileBehavior":{"disableBodyPruning":true},"rawModeData":"{\n \"field\": \"Value\"\n}","graphqlModeData":{}}' createdAt: '2023-09-01T09:29:54.000Z' updatedAt: '2023-09-08T12:37:33.000Z' owner: '12345678' lastUpdatedBy: '12345678' lastRevision: 32368133468 request: c82dd02c-4870-4907-8fcb-593a876cf05b revision: 32473225008 deleteCollectionResponseSuccessfulResponse: value: model_id: cc364734-7dfd-4bfc-897d-be763dcdbb07 meta: model: response action: destroy data: id: cc364734-7dfd-4bfc-897d-be763dcdbb07 owner: '12345678' revision: 24997417224 tag403ErrorNoDeveloperRole: value: type: https://api.postman.com/problems/forbidden title: Access Denied detail: You do not have developer role. Ask your (super)admin to grant you developer role status: 403 tag403ErrorNoViewPermissions: value: type: https://api.postman.com/problems/forbidden title: Access Denied status: 403 detail: You do not have view permission instance: /tags/collections/12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 tag400ErrorExceedsMaxNumberOfTags: value: type: https://api.postman.com/problems/badrequest title: Bad Request detail: body/tags must NOT have more than 5 items status: 400 tag400ErrorInvalidSlugPattern: value: title: Bad Request detail: body/tags/0/slug must match pattern "^[a-z][a-z0-9-]*[a-z0-9]+$" status: 400 tag400ErrorMissingTagsObject: value: statusCode: 400 error: Bad Request message: body must have required property 'tags' transformCollectionToOpenAPISuccessfulJSONResponse: value: output: |- { "openapi": "3.0.3", "info": { "title": "Sample API", "description": "Buy or rent spacecrafts\n\nContact Support:\n Name: Jon", "version": "1.0.0", "contact": {} }, "servers": [ { "url": "example.com" } ], "paths": { "/spacecrafts/{spacecraftId}": { "get": { "tags": [ "spacecrafts", "{spacecraftId}" ], "summary": "Read a spacecraft", "description": "Read a spacecraft", "operationId": "readASpacecraft", "responses": { "200": { "description": "The spacecraft corresponding to the provided `spacecraftId`", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "example": "" }, "id": { "type": "string", "example": "" }, "name": { "type": "string", "example": "" }, "type": { "type": "string", "example": "satellite" } } }, "examples": { "The spacecraft corresponding to the provided `spacecraftId`": { "value": { "description": "", "id": "", "name": "", "type": "satellite" } } } } } }, "404": { "description": "No spacecraft found for the provided `spacecraftId`", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "" } } }, "examples": { "No spacecraft found for the provided `spacecraftId`": { "value": { "message": "" } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "" } } }, "examples": { "Unexpected error": { "value": { "message": "" } } } } } } } }, "parameters": [ { "name": "spacecraftId", "in": "path", "required": true, "schema": { "type": "string", "example": "" }, "description": "(Required) The unique identifier of the spacecraft" } ] } }, "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "name": "X-Api-Key", "in": "header" } } }, "security": [ { "apiKey": [] } ], "tags": [ { "name": "spacecrafts" }, { "name": "{spacecraftId}" } ] } transformCollectionToOpenAPISuccessfulYAMLResponse: value: output: | openapi: 3.0.3 info: title: Sample API description: |- Buy or rent spacecrafts Contact Support: Name: Jon version: 1.0.0 contact: {} servers: - url: example.com paths: /spacecrafts/{spacecraftId}: get: tags: - spacecrafts - "{spacecraftId}" summary: Read a spacecraft description: Read a spacecraft operationId: readASpacecraft responses: "200": description: The spacecraft corresponding to the provided `spacecraftId` content: application/json: schema: type: object properties: description: type: string example: id: type: string example: name: type: string example: type: type: string example: satellite examples: The spacecraft corresponding to the provided `spacecraftId`: value: description: id: name: type: satellite "404": description: No spacecraft found for the provided `spacecraftId` content: application/json: schema: type: object properties: message: type: string example: examples: No spacecraft found for the provided `spacecraftId`: value: message: "500": description: Unexpected error content: application/json: schema: type: object properties: message: type: string example: examples: Unexpected error: value: message: parameters: - name: spacecraftId in: path required: true schema: type: string example: description: (Required) The unique identifier of the spacecraft components: securitySchemes: apiKey: type: apiKey name: X-Api-Key in: header security: - apiKey: [] tags: - name: spacecrafts - name: "{spacecraftId}" collectionToApi401Error: value: type: https://api.postman.com/problems/unauthorized title: Unauthorized detail: Unauthorized status: 401 instance: /collections/{collectionId}/apis collectionToApi404Error: value: type: https://api.postman.com/problems/not-found title: Not Found detail: Not Found status: 404 instance: /collections/{collectionId}/apis collectionToApi500Error: value: type: https://api.postman.com/problems/internal-server-error title: Internal Server Error detail: Internal Server Error status: 500 instance: /collections/{collectionId}/apis transferCollectionItems: value: ids: - 12345678-bcb5648b-eecb-4468-ade7-4efb38431bd1 target: model: collection id: 12345678-2ba6b9c4-5327-4c46-9bf3-4ec84b74b720 location: position: end model: null id: null mode: copy transferCollectionFoldersCopyFolderToCollection: value: ids: - 12345678-bcb5648b-eecb-4468-ade7-4efb38431bd1 transferCollectionFoldersMoveFolderToACollection: value: ids: - 12345678-bcb5648b-eecb-4468-ade7-4efb38431bd1 transferCollectionFoldersMoveFolderBeforeAnotherFolder: value: ids: - 12345678-bcb5648b-eecb-4468-ade7-4efb38431bd1 transferCollectionRequestsCopyRequestToCollection: value: ids: - 12345678-3a2069a1-aeb6-462c-ada0-8629858199ba transferCollectionRequestsMoveRequestToTopOfFolder: value: ids: - 12345678-3a2069a1-aeb6-462c-ada0-8629858199ba transferCollectionRequestsMoveRequestAfterAnotherRequest: value: ids: - 12345678-3a2069a1-aeb6-462c-ada0-8629858199ba transferCollectionResponsesCopyResponseToRequest: value: ids: - 12345678-a9b481c1-3e78-4af7-8db0-dce3f3f3c105 transferCollectionResponsesMoveResponseToRequest: value: ids: - 12345678-a9b481c1-3e78-4af7-8db0-dce3f3f3c105 transferCollectionResponsesMoveResponseBeforeAnotherResponse: value: ids: - 12345678-a9b481c1-3e78-4af7-8db0-dce3f3f3c105 transferCollectionItems400ErrorOneOrMoreFolderIdsProvidedWereNotFound: value: type: Error title: One or more folder ids provided were not found detail: missing: - '12345678' transferCollectionItems400ErrorOneOrMoreRequestIdsProvidedWereNotFound: value: type: Error title: One or more request ids provided were not found detail: missing: - '12345678' transferCollectionItems400ErrorTargetFolderNotFound: value: type: Error title: Target folder 12345678-bcb5648b-eecb-4468-ade7-4efb38431bb9 not found detail: {} transferCollectionItems400ErrorInvalidTargetType: value: type: Error title: Cannot transfer response to target model type folder detail: {} getDuplicateCollectionTaskStatusTaskCompleted: value: task: status: completed reason: null id: 12345678-66ae9950-0869-4e65-96b0-1e0e47e771af getDuplicateCollectionTaskStatusTaskProcessing: value: task: status: processing reason: null id: 12345678-66ae9950-0869-4e65-96b0-1e0e47e771af getDuplicateCollectionTaskStatusTaskFailed: value: task: status: failed id: 12345678-66ae9950-0869-4e65-96b0-1e0e47e771af reason: instance not found duplicationTask400ErrorInvalidId: value: type: https://api.postman.com/problems/bad-request title: Bad request detail: Invalid task id status: 400 common404Error: value: type: https://api.postman.com/problems/not-found title: Not Found detail: Not Found status: 404 common404ErrorResourceNotFound: value: type: https://api.postman.com/problems/not-found title: Not Found status: 404 detail: The requested resource was not found. common404ErrorResourceDoesNotExist: value: type: https://api.postman.com/problems/not-found title: Not Found status: 404 detail: The requested resource does not exist. getCollectionUpdatesTasksSuccess: value: id: 66ae9950-0869-4e65-96b0-1e0e47e771af status: successful getCollectionUpdatesTasksSyncFailed: value: id: 66ae9950-0869-4e65-96b0-1e0e47e771af status: failed getCollectionUpdatesTasksSyncInProgress: value: id: 66ae9950-0869-4e65-96b0-1e0e47e771af status: in-progress getAllComponents: value: data: - id: 01KT964C30J3DPJQKEACZH39N8 name: example-component type: OAS3 status: active createdAt: '2026-01-15T10:30:00.000Z' updatedAt: '2026-01-15T10:30:00.000Z' createdBy: '12345678' updatedBy: '12345678' - id: 01KT964C30J3DPJQKEACZH39N9 name: another-component type: OAS2 status: active createdAt: '2026-01-14T09:20:00.000Z' updatedAt: '2026-01-14T09:20:00.000Z' createdBy: '12345678' updatedBy: '12345678' getAllComponentsIncludeFilter: value: data: - id: 01KT964C30J3DPJQKEACZH39N8 name: example-component hasVersions: true type: OAS3 status: active createdAt: '2026-01-15T10:30:00.000Z' updatedAt: '2026-01-15T10:30:00.000Z' createdBy: '12345678' updatedBy: '12345678' - id: 01KT964C30J3DPJQKEACZH39N9 name: another-component hasVersions: false type: OAS2 status: active createdAt: '2026-01-14T09:20:00.000Z' updatedAt: '2026-01-14T09:20:00.000Z' createdBy: '12345678' updatedBy: '12345678' getAllComponentsIncludeExpandFilters: value: data: - id: 01KT964C30J3DPJQKEACZH39N8 name: example-component latestVersion: id: 01KTK2XSBAA9JHA4KZ4AYTM9VS content: | components: schemas: sampleUser: description: A sample user object type: object properties: id: type: string name: type: string email: type: string required: - id - name - email responses: sampleError: description: A sample error response content: application/json: schema: type: object properties: code: type: string message: type: string required: - code - message parameters: sampleParam: name: limit in: query description: A sample query parameter schema: type: integer minimum: 1 maximum: 100 default: 10 url: https://components.postman.com/example/Test1/1.0.0 label: v1.0.0 publishedAt: '2026-06-08T07:42:31.000Z' format: YAML type: OAS3 status: active createdAt: '2026-01-15T10:30:00.000Z' updatedAt: '2026-01-15T10:30:00.000Z' createdBy: '12345678' updatedBy: '12345678' - id: 01KT964C30J3DPJQKEACZH39N9 name: another-component type: OAS2 status: active createdAt: '2026-01-14T09:20:00.000Z' updatedAt: '2026-01-14T09:20:00.000Z' createdBy: '12345678' updatedBy: '12345678' componentLibrary400ErrorInvalidParameters: value: type: https://api.postman.com/problems/bad-request title: Invalid parameters status: 400 detail: Invalid parameters provided. Please check your input and try again. createComponent: value: name: example-component type: OAS3 content: |- openapi: 3.0.0 info: title: Example API version: 1.0.0 format: YAML createComponentResponse: value: id: 01KT964C30J3DPJQKEACZH39N8 componentLibrary409ErrorCannotPublishVersionConflict: value: type: https://api.postman.com/problems/conflict title: Cannot publish version status: 409 detail: This component is archived. Unarchive it before publishing a new version. componentLibrary409ErrorComponentCannotRenameArchivedConflict: value: type: https://api.postman.com/problems/conflict title: Cannot rename component status: 409 detail: This component is archived. Unarchive it before renaming. componentLibrary409ErrorDuplicateLabel: value: type: https://api.postman.com/problems/conflict title: Duplicate component name status: 409 detail: Component with the same name already exists in the team. componentLibrary409ErrorDuplicateVersionLabel: value: type: https://api.postman.com/problems/conflict title: Duplicate component version label status: 409 detail: Component version with the same label already exists. componentLibrary409ErrorDraftArchivedConflict: value: type: https://api.postman.com/problems/conflict title: Cannot update draft status: 409 detail: This component is archived. Unarchive it before editing the draft. getComponent: value: id: 01KT964C30J3DPJQKEACZH39N8 name: example-component type: OAS3 createdAt: '2026-01-15T10:30:00.000Z' updatedAt: '2026-01-15T10:30:00.000Z' createdBy: '12345678' updatedBy: '12345678' common404ErrorEntityNotFound: value: type: https://api.postman.com/problems/not-found title: Not found status: 404 detail: Entity that you are trying to access does not exist. componentLibrary404ErrorComponentVersionNotFound: value: type: https://api.postman.com/problems/not-found title: Component version not found status: 404 detail: Entity that you are trying to access does not exist. updateComponentName: value: name: update-component-name updateComponentStatus: value: status: archive updateComponentResponse: value: id: 01KT964C30J3DPJQKEACZH39N8 name: updated-component-name status: active getComponentDraft: value: content: |- openapi: 3.0.0 info: title: Example API version: 1.0.0 format: YAML updateComponentDraft: value: content: |- openapi: 3.0.0 info: title: Example API version: 1.0.0 format: YAML updateComponentDraftResponse: value: id: 01KT964C30J3DPJQKEACZH39N8 getComponentVersions: value: data: - id: 01KT9NBTW5GYETHG6V0HNPAPYV label: 1.0.0 format: YAML publishedAt: '2026-01-15T10:30:00.000Z' url: https://components.postman.com/example/Test1/1.0.0 - id: 01KT9NBTW5GYETHG6V0HNPAPYW label: 1.1.0 format: JSON publishedAt: '2026-01-16T09:20:00.000Z' url: https://components.postman.com/example/Test1/1.1.0 createComponentVersionDraftSource: value: label: 1.0.0 source: type: draft createComponentVersionResponse: value: id: 01KT9NBTW5GYETHG6V0HNPAPYV getComponentVersion: value: id: 01KT9NBTW5GYETHG6V0HNPAPYV label: 1.0.0 format: YAML publishedAt: '2026-01-15T10:30:00.000Z' url: https://components.postman.com/example/Test1/1.0.0 submitContextGraphAsk: value: query: What endpoints does authentication-service expose? includeAnswer: true maxSteps: 8 submitContextGraphAskStructuredOnly: value: query: Which APIs depend on the payments service? includeAnswer: false submitContextGraphAskResponse: value: askId: 01a03dd2-0d99-766e-b3df-e36dcaaee706 status: pending contextGraph400ErrorQueryTooShort: value: type: https://api.postman.com/problems/bad-request title: Bad Request detail: 'query: Too small: expected string to have >=1 characters' status: 400 contextGraph403ErrorNoAccess: value: type: https://api.postman.com/problems/forbidden title: Forbidden detail: You do not have access to Context Graph status: 403 contextGraph429ErrorQuotaExceeded: value: type: https://api.postman.com/problems/too-many-requests title: Too Many Requests detail: Ask rate limit exceeded; retry later status: 429 getContextGraphAskResponseCompleted: value: askId: 01a03dd2-114a-766f-820b-4209e4fc78d2 status: completed question: What endpoints does authentication-service expose? revision: 1 createdAt: '2026-08-26T11:26:12.000Z' completedAt: '2026-08-26T11:26:28.000Z' result: answer: The authentication-service exposes 31 endpoints, organized into health checks, public auth, handover and token exchange, certificate management, and internal auth-scheme management. structured: entities: - type: api name: authentication-service provenance: revision: 1 steps: - tool: run_typed_query type: api-detail - tool: run_cypher rowCount: 31 citations: - api_name: authentication-service - path: /api/auth/logout usage: steps: 2 outputTokens: 707 getContextGraphAskResponseRunning: value: askId: 01a03dd2-0d99-766e-b3df-e36dcaaee706 status: running question: Which APIs are in the graph and what does each expose? revision: 1 createdAt: '2026-08-26T11:20:00.000Z' completedAt: null contextGraph404ErrorAskNotFound: value: type: https://api.postman.com/problems/not-found title: Not Found detail: Ask not found status: 404 getAllCustomFunctions: value: data: - id: 01JCUSTOMFN0123456789ABCDE name: checkResourceNesting path: functions/checkResourceNesting.js description: Custom Spectral function. type: custom createdBy: '12345678' updatedBy: '12345678' createdAt: '2026-07-13T10:15:30.000Z' updatedAt: '2026-07-13T11:20:00.000Z' meta: nextCursor: eyJvZmZzZXQiOjEwfQ== createCustomFunction: value: path: functions/checkResourceNesting.js description: Custom Spectral function. content: export default (input) => { return []; }; createCustomFunctionResponse: value: id: 01JCUSTOMFN0123456789ABCDE apiGovernance409ErrorCustomFunctionPathConflict: value: type: https://api.postman.com/problems/conflict title: Conflict status: 409 detail: A custom function at this path already exists. getCustomFunction: value: id: 01JCUSTOMFN0123456789ABCDE name: checkResourceNesting path: functions/checkResourceNesting.js description: Custom Spectral function. type: custom createdBy: '12345678' updatedBy: '12345678' createdAt: '2026-07-13T10:15:30.000Z' updatedAt: '2026-07-13T11:20:00.000Z' getCustomFunctionWithContent: value: id: 01JCUSTOMFN0123456789ABCDE name: checkResourceNesting path: functions/checkResourceNesting.js description: Custom Spectral function. type: custom content: export default (input) => { return []; }; createdBy: '12345678' updatedBy: '12345678' createdAt: '2026-07-13T10:15:30.000Z' updatedAt: '2026-07-13T11:20:00.000Z' updateCustomFunctionMetadata: value: path: functions/checkResourceNestingV2.js description: Updated custom Spectral function. updateCustomFunctionContent: value: content: 'export default (input) => { return [{ message: ''Invalid input'' }]; };' updateCustomFunctionResponse: value: id: 01JCUSTOMFN0123456789ABCDE detectedSecretsQueries: value: secretTypes: - 1a7ec5d1-dcba-4ec7-8220-3c1ee490416b - 3b6ec9d2-dabc-5e67-1220-6coie490416b resolved: true statuses: - ACCEPTED_RISK - REVOKED workspaceIds: - 0fe6c2f2-022d-48f7-8e7e-3244369445b0 - 80ab14ae-c17d-4fd6-88d5-99bf13f0b7f0 workspaceVisibilities: - team detectedSecretsQueryResource: value: resolved: false secretTypes: - 3fd32ec0-c2ee-45f4-9701-878c90127f79 resources: - type: example ids: - 12345678-400005df-3cad-480c-a027-ea68aed35b60 detectedSecretsQueryResponse: value: meta: limit: 2 nextCursor: MTA4 data: - detectedAt: '2023-05-19T02:45:31.000Z' secretType: Airtable API Key workspaceVisibility: team secretHash: 07afd1f787f3555d441b04870dbe1025db8309fbeb31f25b3a20f2f1241478b3 workspaceId: e361eeb4-00dd-4225-9774-6146a2555999 secretId: OTI3OTYx obfuscatedSecret: keyTF2WAH****** resolution: FALSE_POSITIVE occurrences: 3 - detectedAt: '2023-03-23T19:38:49.000Z' secretType: Slack Access Token workspaceVisibility: team secretHash: 08074c0954fd29d1ee82ab5af9b4ad16f56b0907eca72446e98dc97e10da80a3 workspaceId: e361eeb4-00dd-4225-9774-6146a2555999 secretId: NDcyMjA= obfuscatedSecret: xoxp-25519****** resolution: ACCEPTED_RISK occurrences: 1 detectedSecretsQueryIncludeParam: value: meta: limit: 2 nextCursor: MTA4 total: 10 data: - detectedAt: '2023-05-19T02:45:31.000Z' secretType: Airtable API Key workspaceVisibility: team secretHash: 07afd1f787f3555d441b04870dbe1025db8309fbeb31f25b3a20f2f1241478b3 workspaceId: e361eeb4-00dd-4225-9774-6146a2555999 secretId: OTI3OTYx obfuscatedSecret: keyTF2WAH****** resolution: FALSE_POSITIVE occurrences: 3 - detectedAt: '2023-03-23T19:38:49.000Z' secretType: Slack Access Token workspaceVisibility: team secretHash: 08074c0954fd29d1ee82ab5af9b4ad16f56b0907eca72446e98dc97e10da80a3 workspaceId: e361eeb4-00dd-4225-9774-6146a2555999 secretId: NDcyMjA= obfuscatedSecret: xoxp-25519****** resolution: ACCEPTED_RISK occurrences: 1 detectedSecretsQueryFilterByResource: value: meta: limit: 30 nextCursor: null data: - detectedAt: '2023-03-23T19:30:58.000Z' secretType: Basic Auth workspaceVisibility: team secretHash: 3b4db9cb32935e885468d80744a65194b7abdb18bb91ce6cbc2ad7852057d96e workspaceId: 01cb2666-9e05-47d3-9043-3b4743f42f1a resourceId: 12345678-400005df-3cad-480c-a027-ea68aed35b60 resourceType: example secretId: MTAxOTQ0Mw== obfuscatedSecret: Basic Q2****** resolution: ACTIVE occurrences: 3 secretScanner400Error: value: instance: '' status: 400 title: limit specified is invalid type: BAD_REQUEST detectedSecrets400FilterError: value: type: BAD_REQUEST title: Invalid filters specified instance: '' status: 400 detail: '`workspaceIds` and `resources` filters are exclusive - only one can be applied at a time.' detectedSecrets400InvalidResourcesError: value: type: BAD_REQUEST title: Invalid resources specified instance: '' status: 400 detail: one or more `resources` are invalid. secretScanner401Error: value: instance: '' status: 401 title: Unauthorized. Please try again with valid credentials. type: UNAUTHORIZED secretScanner403ErrorNoPermission: value: instance: '' status: 403 title: Only members with Superadmin, Admin, or Workspace Admin roles can view the detected secrets. type: FORBIDDEN secretScanner403ErrorAdvSecAdminMissing: value: instance: '' status: 403 title: This feature is only available with "Advanced Security Administration" add-on. Contact your team admin to purchase this add-on. type: FORBIDDEN secretScanner500Error: value: instance: '' status: 500 title: An error occurred type: SERVER_ERROR updateSecretResolutions: value: resolution: ACCEPTED_RISK workspaceId: e361eeb4-00dd-4225-9774-6146a2555999 updateSecretResolutionsResponse: value: secretHash: 50dbd2... workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 resolution: ACCEPTED_RISK history: - actor: 12345678 createdAt: '2024-09-18T18:46:26.000Z' resolution: FALSE_POSITIVE - actor: 12345678 createdAt: '2024-09-18T18:43:11.000Z' resolution: ACCEPTED_RISK secretScanner400InvalidResolutionError: value: type: BAD_REQUEST title: '`resolution` must be one of FALSE_POSITIVE, ACCEPTED_RISK, REVOKED, ACTIVE' instance: TEST status: 400 getSecretsLocations: value: data: - isResourceDeleted: false leakedBy: 12345678 location: Headers occurrences: 1 parentResourceId: 12345678-14728df4-c7af-424f-b665-5047b7d25866 resourceId: 12345678-e0df25e0-d245-40dd-89b5-68720d186d3f resourceType: example detectedAt: '2023-04-25T08:13:48.000Z' url: https://go.postman.co/build/workspace/80ab14ae-c17d-4fd6-88d5-99bf13f0b7f0/example/12345678-e0df25e0-d245-40dd-89b5-68720d186d3f meta: activityFeed: - resolvedBy: 12345678 status: ACTIVE resolvedAt: '2023-04-25T11:18:07.000Z' cursor: MTIyNjY5Nw== limit: 2 nextCursor: null obfuscatedSecret: PMAK-644781584627df042afa6655-******ba secretHash: 0096b35ef6621d7571f106fefee5b10e8ed360cc9bf04f343f267ca4ff65bb5d secretType: Postman API Key total: 3 secretScanner400InvalidResourceTypeError: value: type: BAD_REQUEST title: Invalid resourceType specified instance: collections status: 400 getAsyncCollectionTaskStatusPending: value: status: pending meta: model: collection action: generation getAsyncCollectionTaskStatus: value: meta: action: generation model: collection details: resources: - id: 12345678-e726de58-f1b3-4edd-a8a7-2579dc799d39 url: /collections/e726de58-f1b3-4edd-a8a7-2579dc799d39 status: completed getAsyncCollectionTaskStatusFailure: value: details: Failed to sync collection with specification meta: model: collection action: generation status: failed getEnvironments: value: environments: - id: 5daabc50-8451-43f6-922d-96b403b4f28e name: Test Environment createdAt: '2020-09-23T14:31:18.000Z' updatedAt: '2020-12-04T14:13:40.000Z' owner: '12345678' uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e isPublic: false - id: 7d786cc8-142b-4d62-b5a5-872afc37ad16 name: Environment Scanner createdAt: '2020-02-04T19:34:23.000Z' updatedAt: '2020-08-12T13:34:06.000Z' owner: '12345678' uid: 12345678-7d786cc8-142b-4d62-b5a5-872afc37ad16 isPublic: false getEnvironmentsFilterByWorkspace: value: environments: - id: 5daabc50-8451-43f6-922d-96b403b4f28e name: Test Environment createdAt: '2020-09-23T14:31:18.000Z' updatedAt: '2020-12-04T14:13:40.000Z' owner: '12345678' uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e isPublic: false environment200invalidWorkspace: value: environments: [] environments404ErrorEnvDoesNotExist: value: error: name: instanceNotFoundError message: The specified environment does not exist. environments404ErrorInstanceNotFound: value: error: name: instanceNotFoundError message: We could not find the environment you are looking for environments404ErrorNotFound: value: type: https://api.postman.com/problems/not-found status: 404 title: Not Found detail: Not Found instance: /environments/5daabc50-8451-43f6-922d-96b403b4f28e createEnvironment: value: environment: name: Test Environment values: - key: collectionId value: 12ece9e1-2abf-4edc-8e34-de66e74114d2 enabled: true type: default description: The collection's ID. - key: variable_1 value: The variable_1 value. enabled: false type: default description: Placeholder variable value. - enabled: true key: apiKey secret: true source: postman: secretId: f5fa5280-18a3-4d93-a706-2fe48b1007dc type: cloud vaultId: 453a311c-c5b4-4627-8e51-a3bd48953734 provider: postman type: default value: '' createEnvironmentResponse: value: environment: id: 5daabc50-8451-43f6-922d-96b403b4f28e name: Test Environment uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e environments400ErrorInvalidType: value: error: name: malformedRequestError message: 'Invalid type: null (expected object) at environment.values.0' environments400ErrorMalformedRequest: value: error: name: malformedRequestError message: Found 1 errors with the supplied environment. details: - 'environment: must have required property ''name''' common411Error: value: type: https://api.postman.com/problems/length-required title: Length Required detail: A valid Content-Length header is required status: 411 instance: / common413Error: value: type: https://api.postman.com/problems/payload-too-large title: Payload Too Large detail: Request size limit exceeded status: 413 instance: / getEnvironment: value: environment: id: 5daabc50-8451-43f6-922d-96b403b4f28e name: Test Environment owner: '12345678' createdAt: '2020-11-05T13:59:22.000Z' updatedAt: '2020-11-05T13:59:23.000Z' values: - key: collectionId value: 12ece9e1-2abf-4edc-8e34-de66e74114d2 enabled: true type: default description: The collection's ID. - enabled: true key: apiKey secret: true source: postman: secretId: f5fa5280-18a3-4d93-a706-2fe48b1007dc type: cloud vaultId: 453a311c-c5b4-4627-8e51-a3bd48953734 provider: postman type: default isPublic: false putEnvironment: value: environment: name: Test A Environment values: - key: collectionId value: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 type: default enabled: true description: The collection's ID. - enabled: true key: apiKey secret: true source: postman: secretId: f5fa5280-18a3-4d93-a706-2fe48b1007dc type: cloud vaultId: 453a311c-c5b4-4627-8e51-a3bd48953734 provider: postman type: default value: '' putEnvironmentRemoveVariables: value: environment: values: [] putEnvironmentResponse: value: environment: id: 5daabc50-8451-43f6-922d-96b403b4f28e name: Test A Environment uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e deleteEnvironment: value: environment: id: 5daabc50-8451-43f6-922d-96b403b4f28e uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e patchEnvironmentAddDescriptionToExistingVariable: value: - op: add path: /values/0/description value: A valid API key. patchEnvironmentAddVariable: value: - op: add path: /values/1 value: key: collectionId value: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 type: default enabled: true description: The collection's ID. patchEnvironmentAddSecretVariable: value: - op: add path: /values/1 value: enabled: true key: apiKey secret: true source: postman: secretId: f5fa5280-18a3-4d93-a706-2fe48b1007dc type: cloud vaultId: 453a311c-c5b4-4627-8e51-a3bd48953734 provider: postman type: default value: '' patchEnvironmentEnableVariable: value: - op: replace path: /values/0/enabled value: true patchEnvironmentRemove: value: - op: remove path: /values/0 patchEnvironmentRemoveMultiple: value: - op: remove path: /values/4 - op: remove path: /values/3 - op: remove path: /values/2 - op: remove path: /values/1 patchEnvironmentRemoveAdd: value: - op: remove path: /values/1 - op: remove path: /values/0 - op: add path: /values/0 value: key: x-api-key value: '{{x-api-key}}' type: default enabled: true description: A valid API key. patchEnvironmentUnshareVariable: value: - op: remove path: /values/0/key patchEnvironmentName: value: - op: replace path: /name value: Test API Environment patchEnvironmentUpdateVariable: value: - op: replace path: /values/0/key value: x-api-key - op: replace path: /values/0/enabled value: false - op: replace path: /values/0/value value: '{{x-api-key}}' - op: replace path: /values/0/type value: secret - op: replace path: /values/0/description value: A valid API key. - op: replace path: /values/1/secret value: true - op: replace path: /values/1/source value: postman: secretId: 082351ca-810e-476b-8437-d098b20fba4b type: cloud vaultId: 04084949-0dda-4735-ace5-f83038f7b200 provider: postman patchEnvironment: value: environment: id: 5daabc50-8451-43f6-922d-96b403b4f28e name: Test API Environment owner: '12345678' createdAt: '2025-03-10T15:37:00.000Z' updatedAt: '2025-03-10T15:56:19.000Z' values: - key: x-api-key value: '{{x-api-key}}' type: secret enabled: true uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e patchEnvironmentAddVariableResponse: value: environment: id: 5daabc50-8451-43f6-922d-96b403b4f28e name: Test API Environment owner: '12345678' createdAt: '2025-03-10T15:37:00.000Z' updatedAt: '2025-03-10T15:56:19.000Z' values: - key: x-api-key value: '{{x-api-key}}' type: secret enabled: true - key: collectionId value: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 type: default enabled: true description: The collection's ID. uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e patchEnvironmentAddDescriptionResponse: value: environment: id: 5daabc50-8451-43f6-922d-96b403b4f28e name: Test API Environment owner: '12345678' createdAt: '2025-03-10T15:37:00.000Z' updatedAt: '2025-03-10T15:54:02.000Z' values: - key: x-api-key value: '{{x-api-key}}' type: secret enabled: false description: A valid API key. uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e patchEnvironmentEnableVariableResponse: value: environment: id: 5daabc50-8451-43f6-922d-96b403b4f28e name: Test API Environment owner: '12345678' createdAt: '2025-03-10T15:37:00.000Z' updatedAt: '2025-03-10T15:54:02.000Z' values: - key: x-api-key value: '{{x-api-key}}' type: secret enabled: true uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e patchEnvironmentUpdateVariableResponse: value: environment: id: 5daabc50-8451-43f6-922d-96b403b4f28e name: Test API Environment owner: '12345678' createdAt: '2025-03-10T15:37:00.000Z' updatedAt: '2025-03-10T15:54:02.000Z' values: - key: x-api-key value: '{{x-api-key}}' type: secret enabled: false description: A valid API key. - enabled: true key: apiKey secret: true source: postman: secretId: 082351ca-810e-476b-8437-d098b20fba4b type: cloud vaultId: 04084949-0dda-4735-ace5-f83038f7b200 provider: postman type: default value: '' uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e patchEnvironmentAddSecretVariableResponse: value: environment: id: 5daabc50-8451-43f6-922d-96b403b4f28e name: Test API Environment owner: '12345678' createdAt: '2025-03-10T15:37:00.000Z' updatedAt: '2025-03-10T15:56:19.000Z' values: - key: x-api-key value: '{{x-api-key}}' type: secret enabled: true - key: collectionId value: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 type: default enabled: true description: The collection's ID. - enabled: true key: apiKey secret: true source: postman: secretId: f5fa5280-18a3-4d93-a706-2fe48b1007dc type: cloud vaultId: 453a311c-c5b4-4627-8e51-a3bd48953734 provider: postman type: default value: '' uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e patchEnvironmentUnshareVariableResponse: value: environment: id: 5daabc50-8451-43f6-922d-96b403b4f28e name: Test API Environment owner: '12345678' createdAt: '2025-03-10T15:37:00.000Z' updatedAt: '2025-03-10T15:54:02.000Z' values: - key: x-api-key value: '{{x-api-key}}' type: secret enabled: false description: A valid API key. - enabled: true key: apiKey secret: true source: postman: secretId: 082351ca-810e-476b-8437-d098b20fba4b type: cloud vaultId: 04084949-0dda-4735-ace5-f83038f7b200 provider: postman type: default value: '' uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e patchEnvironmentRemoveVariableResponse: value: environment: id: 5daabc50-8451-43f6-922d-96b403b4f28e name: Test API Environment owner: '12345678' createdAt: '2025-03-10T15:16:18.000Z' updatedAt: '2025-03-10T15:17:04.000Z' values: [] uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e patchEnvironmentRemoveMultipleVariablesResponse: value: environment: id: 5daabc50-8451-43f6-922d-96b403b4f28e name: Test API Environment owner: '12345678' createdAt: '2025-03-10T15:37:00.000Z' updatedAt: '2025-03-10T15:54:02.000Z' values: - key: x-api-key value: '{{x-api-key}}' type: default enabled: true uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e patchEnvironmentRemoveAndAddVariableResponse: value: environment: id: 5daabc50-8451-43f6-922d-96b403b4f28e name: Test API Environment owner: '12345678' createdAt: '2025-03-10T15:37:00.000Z' updatedAt: '2025-03-10T15:54:02.000Z' values: - key: x-api-key value: '{{x-api-key}}' type: default enabled: true description: A valid API key. uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e patchEnvironment400ErrorInvalidPatchBody: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: Patch sequence must be an array patchEnvironment400ErrorEmptyValue: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: Patch operations with empty value are not supported environments400ErrorInvalidId: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: Invalid Environment ID instance: /environments/5daabc50-8451-43f6 patchEnvironment400ErrorInvalidValue: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: - '/values/1/value: must be a string' patchEnvironment400ErrorInvalidPath: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: Invalid path in JSON Patch operation instance: /environments/5daabc50-8451-43f6-922d-96b403b4f28e patchEnvironment400ErrorPath: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: Cannot perform the operation at a path that does not exist instance: /environments/5daabc50-8451-43f6-922d-96b403b4f28e environments403ErrorForbidden: value: type: https://api.postman.com/problems/forbidden status: 403 title: Forbidden detail: Forbidden instance: /environments/5daabc50-8451-43f6-922d-96b403b4f28e getEnvironmentForks: value: data: - forkName: Test Fork createdBy: '12345678' forkId: 12345678-0fcea3ba-abcf-49c3-9f48-669c208fef25 createdAt: '2024-01-30T16:42:22.000Z' updatedAt: '2024-03-21T15:51:42.000Z' - forkName: 'Test Fork #2' createdBy: '12345678' forkId: 12345678-b7f0ded7-d614-4f74-baef-1006f6ab8a7b createdAt: '2024-01-30T16:39:25.000Z' updatedAt: '2024-03-21T15:51:42.000Z' - forkName: My fork createdBy: '87654321' forkId: 87654321-ed71be39-27b8-4886-bb74-77cb047d4fa6 createdAt: '2024-01-30T16:39:17.000Z' updatedAt: '2024-03-21T15:51:42.000Z' - forkName: Alex Cruz's fork createdBy: '87654321' forkId: 872905-c439ede2-4c40-4f25-82b2-a1a1219ead94 createdAt: '2024-01-30T16:39:09.000Z' updatedAt: '2024-03-21T15:51:42.000Z' - forkName: Taylor Lee's Fork createdBy: '12345678' forkId: 12345678-65c0a895-1428-45ea-bff0-f0f48e87f044 createdAt: '2024-01-30T16:39:02.000Z' updatedAt: '2024-03-21T15:51:42.000Z' - forkName: Test 1 createdBy: '87654321' forkId: 87654321-3ad67987-91c4-4bd6-b624-348a5ea14e69 createdAt: '2024-01-30T16:38:52.000Z' updatedAt: '2024-03-21T15:51:42.000Z' - forkName: 'Test #2' createdBy: '56781234' forkId: 56781234-c7e91b68-c39e-4735-a103-da47c98a5f01 createdAt: '2024-01-30T16:38:27.000Z' updatedAt: '2024-03-21T15:51:42.000Z' - forkName: 'Test Fork #3' createdBy: '12345678' forkId: 12345678-00dcac5b-e81a-4250-bb9a-7878df2a7a03 createdAt: '2024-01-30T16:38:18.000Z' updatedAt: '2024-03-21T15:51:42.000Z' - forkName: Alex Cruz's fork 1 createdBy: '87654321' forkId: 87654321-6dd33d0c-36eb-4542-a5f2-bb2a70303f63 createdAt: '2024-01-30T16:38:10.000Z' updatedAt: '2024-03-21T15:51:42.000Z' - forkName: Test 2 createdBy: '56781234' forkId: 56781234-27eed2fc-8f05-4083-b8d4-55074bc49631 createdAt: '2024-01-30T16:38:01.000Z' updatedAt: '2024-03-21T15:51:42.000Z' - forkName: Taylor Lee's Fork 2 createdBy: '12345678' forkId: 12345678-f96f3b83-3fc4-49a6-bd0b-6bf4162ac9f9 createdAt: '2024-01-30T16:37:51.000Z' updatedAt: '2024-03-21T15:51:42.000Z' - forkName: My fork 3 createdBy: '56781234' forkId: 56781234-69068628-c150-4b0e-a191-1e58a6be46c6 createdAt: '2024-01-30T16:24:19.000Z' updatedAt: '2024-03-21T15:51:42.000Z' meta: nextCursor: NTg3NjgtNTg3NTctNTg3NjgtNTAtY3JlYXRlZEF0LWRlc2MtZmFsc2UtLS0xLTEtMTItW1s1ODc2OCw1ODc1N11d total: 12 environmentForks400ErrorNotForked: value: type: https://api.postman.com/problems/bad-request title: The environment Id is not a forked environment. detail: {} environmentForks404Error: value: title: Not Found status: 404 detail: We could not find the environment you are looking for type: https://api.postman.com/problems/notFound forkEnvironment: value: forkName: My fork forkEnvironmentResponse: value: environment: uid: 12345678-0fcea3ba-abcf-49c3-9f48-669c208fef25 name: Testing Environment forkName: Test Fork mergeEnvironmentFork: value: source: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957 deleteSource: false mergeEnvironmentForkResponse: value: environment: uid: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957 pullEnvironment: value: source: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957 pullEnvironmentResponse: value: environment: uid: 12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957 getAllGovernanceGroups: value: data: - id: 01JWSGROUP0123456789ABCDEF name: Payments workspaces description: All payments-related workspaces. type: custom createdBy: '12345678' updatedBy: '12345678' createdAt: '2026-07-13T10:15:30.000Z' updatedAt: '2026-07-13T11:20:00.000Z' meta: nextCursor: eyJvZmZzZXQiOjEwfQ== createGovernanceGroup: value: name: Payments workspaces description: All payments-related workspaces. createGovernanceGroupResponse: value: id: 01JWSGROUP0123456789ABCDEF apiGovernance409ErrorGovernanceGroupNameConflict: value: type: https://api.postman.com/problems/conflict title: Conflict status: 409 detail: A governance group with this name already exists. updateGovernanceGroup: value: name: Payments workspaces (v2) updateGovernanceGroupResponse: value: id: 01JWSGROUP0123456789ABCDEF getGovernanceGroupAssignments: value: data: - rulesetId: 01JABCDEF0123456789ABCDEFG targetType: governance_group targetId: 01JWSGROUP0123456789ABCDEF getGovernanceGroupWorkspaces: value: data: - id: 5b01136d-4231-4b8d-95c8-ef9f7c779dd7 - id: 7c22247e-5342-4c9e-a6d9-fa0a8d880ee8 meta: nextCursor: eyJvZmZzZXQiOjEwfQ== updateGovernanceGroupWorkspaces: value: create: - 5b01136d-4231-4b8d-95c8-ef9f7c779dd7 delete: - 7c22247e-5342-4c9e-a6d9-fa0a8d880ee8 updateGovernanceGroupWorkspacesResponse: value: {} apiGovernance409ErrorWorkspaceAssignmentConflict: value: type: https://api.postman.com/problems/conflict title: Conflict status: 409 detail: One or more workspaces are already assigned to a governance group. getGroups: value: data: - updatedAt: '2024-10-03T14:05:05.000Z' members: - 12345678 - 87654321 - 56781234 teamId: 1 id: 123 name: API Test Group summary: API testing group. roles: - user createdAt: '2024-10-03T14:05:05.000Z' createdBy: 12345678 - updatedAt: '2024-04-04T13:36:11.000Z' members: - 56789012 teamId: 1 id: 456 name: Billing summary: '' roles: - user createdAt: '2024-03-06T11:01:42.000Z' createdBy: 12345678 - updatedAt: '2024-03-15T19:44:20.000Z' members: - 12345678 - 87654321 - 56781234 - 78906531 - 45507812 teamId: 1 id: 789 name: Collaboration summary: '' roles: - user createdAt: '2024-03-15T19:44:20.000Z' createdBy: 12345678 getGroup: value: id: 123 teamId: 1 name: API Test Group summary: API testing group. createdBy: 12345678 createdAt: '2024-10-03T14:05:05.000Z' updatedAt: '2024-10-03T14:05:05.000Z' members: - 12345678 - 87654321 - 56781234 roles: - user managers: - 12345678 importOpenApiStringDefinition: value: type: string input: |- { "openapi": "3.0.0", "servers": [ { "url": "example.com" } ], "info": { "contact": { "name": "Jon" }, "version": "1.0.0", "title": "Sample API", "description": "Buy or rent spacecrafts" }, "paths": { "/spacecrafts/{spacecraftId}": { "parameters": [ { "name": "spacecraftId", "description": "The unique identifier of the spacecraft", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SpacecraftId" } } ], "get": { "summary": "Read a spacecraft", "responses": { "200": { "description": "The spacecraft corresponding to the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Spacecraft" } } } }, "404": { "description": "No spacecraft found for the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "#/components/schemas/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key" } } }, "security": [ { "ApiKey": [] } ] } importOpenApiStringDefinitionOptions: value: type: string options: folderStrategy: Paths disableOptionalParameters: true exampleParametersResolution: Schema input: |- { "openapi": "3.0.0", "servers": [ { "url": "example.com" } ], "info": { "contact": { "name": "Jon" }, "version": "1.0.0", "title": "Sample API", "description": "Buy or rent spacecrafts" }, "paths": { "/spacecrafts/{spacecraftId}": { "parameters": [ { "name": "spacecraftId", "description": "The unique identifier of the spacecraft", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SpacecraftId" } } ], "get": { "summary": "Read a spacecraft", "responses": { "200": { "description": "The spacecraft corresponding to the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Spacecraft" } } } }, "404": { "description": "No spacecraft found for the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "#/components/schemas/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key" } } }, "security": [ { "ApiKey": [] } ] } importOpenApiDefinition: value: collections: - id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Sample API uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 import400ErrorInvalidParameters: value: error: name: invalidParamsError message: The request body has invalid values for the type parameter. Value must be one of file, string, json details: param: type import400ErrorMissingParameters: value: error: name: paramMissingError message: The request body is missing a value for the type parameter. Check your request and try again. details: param: type import400ErrorUnsupportedOASVersion: value: error: name: invalidParamsError message: 'Unsupported OpenAPI version: 3.2.0. Postman API only supports versions 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0' managePartnerWorkspaceInvitesInvitePartners: value: action: invite_partner targetEntity: workspace targetEntityId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 roleId: '4' target: emails: - alex.cruz@example.com - mike.brown@example.com - sara.smith@example.com managePartnerWorkspaceInvitesRemovePartnerFromWorkspace: value: action: remove_partner targetEntity: workspace targetEntityId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 target: userIds: - '56781234' managePartnerWorkspaceInvitesRemovePartnerFromTeam: value: action: remove_partner targetEntity: team targetEntityId: '123' target: userIds: - '56781234' managePartnerWorkspaceInvitesInvitePartnerResponse: value: targetEntity: workspace targetEntityId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 roleId: '4' action: invite_partner roleDisplayName: Viewer results: - status: PARTNER_ADDED userId: '56781234' message: Partner added to workspace email: alex.cruz@example.com - status: ALREADY_INVITED email: mike.brown@xample.com invitationLink: https://go.postman.com/invite-signup?invite_code=XXX message: Pending invite exists - status: EMAIL_SENT email: sara.smith@example.com invitationLink: https://go.postman.com/invite-signup?invite_code=XXX managePartnerWorkspaceInvitesInvitePartnerPartialSuccessResponse: value: action: invite_partner targetEntity: workspace targetEntityId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 roleId: '4' roleDisplayName: Viewer results: - status: PARTNER_ADDED userId: '56781234' message: Partner added to workspace email: alex.cruz@example.com - status: ALREADY_INVITED email: mike.brown@xample.com invitationLink: https://go.postman.com/invite-signup?invite_code=XXX message: Pending invite exists - email: sara.smith@example.com status: FAILED message: Failed to process invitation managePartnerWorkspaceInvitesPartialRemovePartnerResponse: value: action: remove_partner targetEntity: workspace targetEntityId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 results: - userId: '56781234' status: REMOVED - userId: '12348765' status: FAILED message: Failed to remove partner from all workspaces - userId: '34567812' status: FAILED error: Partner information not found managePartnerWorkspaceInvitesRemovePartnerFromWorkspaceResponse: value: targetEntity: workspace targetEntityId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 action: remove_partner results: - userId: '56781234' status: REMOVED managePartnerWorkspaceInvitesRemovePartnerFromTeamResponse: value: targetEntity: team targetEntityId: '123' action: remove_partner results: - userId: '56781234' status: REMOVED managePartnerWorkspaceInvites400ErrorInvalidAction: value: type: https://api.postman.com/problems/bad-request title: Invalid request body. detail: 'Invalid "action" property - should be one of: invite_partner, remove_partner' status: 400 managePartnerWorkspaceInvites400ErrorInvalidPartnerWorkspace: value: type: https://api.postman.com/problems/bad-request title: invalidWorkspaceType detail: Workspace is not a partner workspace. status: 400 managePartnerWorkspaceInvites400ErrorInvalidWorkspaceRole: value: type: https://api.postman.com/problems/bad-request title: invalidPartnerRole detail: 'Invalid role for partner workspace. Expected one of: 4, 5, 6, 7' status: 400 managePartnerWorkspaceInvites400ErrorMissingProperties: value: type: https://api.postman.com/problems/bad-request title: badRequest detail: Missing properties in request body - should have "action", "targetEntity", "targetEntityId", "roleId", "target" status: 400 managePartnerWorkspaceInvites403ErrorForbidden: value: type: https://api.postman.com/problems/forbidden title: forbidden detail: You do not have permission to invite partners to this workspace. status: 403 managePartnerWorkspaceInvites404ErrorNotFound: value: type: https://api.postman.com/problems/not-found title: workspaceNotFound detail: Workspace not found status: 404 getAuthenticatedUser: value: user: id: 12345678 sub: 4d71435e-0e67-45b9-9d4c-e3262166d157 username: taylor-lee email: taylor.lee@example.com fullName: Taylor Lee avatar: https://res.cloudinary.com/postman/image/upload/t_user_profile_300/v1/user/default-6 isPublic: true emailVerified: true teamId: 123 teamName: Test Team teamDomain: test-team roles: - user - flow-editor - community-manager operations: - name: api_object_usage limit: 99999999 usage: 8872 overage: 0 - name: collection_run_limit limit: 99999999 usage: 226 overage: 0 - name: file_storage_limit limit: 1 usage: 0.28 overage: 0 - name: flow_requests limit: 1000000 usage: 1852 overage: 0 - name: performance_test_limit limit: 99999999 usage: 10 overage: 0 - name: reusable_packages limit: 100 usage: 48 overage: 0 - name: test_data_retrieval limit: 1000 usage: 180 overage: 0 - name: test_data_storage limit: 10 usage: 0.55 overage: 0 - name: postbot_calls limit: 2500 usage: 0 overage: 0 - name: mock_usage limit: 1000000 usage: 79948 overage: 0 - name: monitor_request_runs limit: 15000000 usage: 4493710 overage: 0 - name: api_usage limit: 1000000 usage: 10788 overage: 0 getMocks: value: mocks: - id: e3d951bf-873f-49ac-a658-b2dcb91d3289 owner: '12345678' deactivated: false uid: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289 collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 mockUrl: https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io name: Test Mock A config: headers: [] matchBody: false matchHeader: false matchQueryParams: true matchWildcards: true delay: type: fixed duration: 140000 serverResponseId: null createdAt: '2022-07-25T20:54:30.000Z' updatedAt: '2022-07-25T20:54:30.000Z' isPublic: false environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e - id: cf0f8f11-fe0e-455f-99f3-4177f10f0704 owner: '12345678' deactivated: false uid: 12345678-cf0f8f11-fe0e-455f-99f3-4177f10f0704 collection: 12345678-2cd8f6b1-e85b-46a6-8111-bd62e73e8aa8 mockUrl: https://cf0f8f11-fe0e-455f-99f3-4177f10f0704.mock.pstmn.io name: Test Mock B config: headers: [] matchBody: false matchHeader: false matchQueryParams: true matchWildcards: true delay: null serverResponseId: 94d0f5d9-dbdf-4046-9a7d-a11f9b78ac65 createdAt: '2023-01-26T18:59:05.000Z' updatedAt: '2023-01-26T18:59:05.000Z' isPublic: false environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e getMocksFilterByTeamId: value: mocks: - id: e3d951bf-873f-49ac-a658-b2dcb91d3289 owner: '12345678' deactivated: false uid: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289 collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 mockUrl: https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io name: Test Mock A config: headers: [] matchBody: false matchHeader: false matchQueryParams: true matchWildcards: true delay: type: fixed duration: 140000 serverResponseId: null createdAt: '2022-07-25T20:54:30.000Z' updatedAt: '2022-07-25T20:54:30.000Z' isPublic: false environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e - id: cf0f8f11-fe0e-455f-99f3-4177f10f0704 owner: '12345678' deactivated: false uid: 12345678-cf0f8f11-fe0e-455f-99f3-4177f10f0704 collection: 12345678-2cd8f6b1-e85b-46a6-8111-bd62e73e8aa8 mockUrl: https://cf0f8f11-fe0e-455f-99f3-4177f10f0704.mock.pstmn.io name: Test Mock B config: headers: [] matchBody: false matchHeader: false matchQueryParams: true matchWildcards: true delay: null serverResponseId: 94d0f5d9-dbdf-4046-9a7d-a11f9b78ac65 createdAt: '2023-01-26T18:59:05.000Z' updatedAt: '2023-01-26T18:59:05.000Z' isPublic: false - id: e27fe349-bdc7-4f1c-b707-6b9fef7435e2 owner: '87654321' deactivated: false uid: 87654321-e27fe349-bdc7-4f1c-b707-6b9fef7435e2 collection: 87654321-b75dfb85-9209-4212-8f3d-a9d5e28167e5 mockUrl: https://e27fe349-bdc7-4f1c-b707-6b9fef7435e2.mock.pstmn.io name: Test Mock C config: headers: [] matchBody: false matchHeader: false matchQueryParams: true matchWildcards: true delay: null serverResponseId: null createdAt: '2023-06-30T14:21:54.000Z' updatedAt: '2023-06-30T14:26:55.000Z' isPublic: true environment: 87654321-5daabc50-8451-43f6-922d-96b403b4f28e getMocksFilterByWorkspace: value: mocks: - id: e3d951bf-873f-49ac-a658-b2dcb91d3289 owner: '12345678' deactivated: false uid: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289 collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 mockUrl: https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io name: Test Mock A config: headers: [] matchBody: false matchHeader: false matchQueryParams: true matchWildcards: true delay: type: fixed duration: 140000 serverResponseId: null createdAt: '2022-07-25T20:54:30.000Z' updatedAt: '2022-07-25T20:54:30.000Z' isPublic: false environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e - id: c929c990-59f1-480a-aea4-c37e25c8785d owner: '12345678' deactivated: false uid: 12345678-b86af87f-7e1f-4476-85bb-c1f71424fd5e collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 mockUrl: https://c929c990-59f1-480a-aea4-c37e25c8785d.mock.pstmn.io name: Test config: headers: [] matchBody: false matchHeader: false matchQueryParams: true matchWildcards: true delay: null serverResponseId: null createdAt: '2023-06-30T12:57:40.000Z' updatedAt: '2023-06-30T12:57:40.000Z' isPublic: false environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e getMocksNoMocksFound: value: mocks: [] common500ErrorServerErrorSomethingWrong: value: error: type: serverError message: Something went wrong with the server createMock: value: mock: name: Test Mock collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e private: true mockCreateUpdate: value: mock: id: e3d951bf-873f-49ac-a658-b2dcb91d3289 owner: '12345678' uid: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289 collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 mockUrl: https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io name: Test Mock config: headers: [] matchBody: false matchHeader: false matchQueryParams: true matchWildcards: true delay: null serverResponseId: null createdAt: '2022-06-09T19:38:06.000Z' updatedAt: '2022-06-13T18:55:25.000Z' environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e updateMockCollectionEnvironmentResponse: value: mock: id: e3d951bf-873f-49ac-a658-b2dcb91d3289 owner: '12345678' uid: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289 collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 mockUrl: https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io name: Test Mock config: headers: [] matchBody: false matchHeader: false matchQueryParams: true matchWildcards: true delay: null serverResponseId: null createdAt: '2022-06-09T19:38:06.000Z' updatedAt: '2022-06-13T18:55:25.000Z' environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e updateMockActivateServerResponse: value: mock: id: e3d951bf-873f-49ac-a658-b2dcb91d3289 owner: '12345678' uid: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289 collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 mockUrl: https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io name: Test Mock config: headers: [] matchBody: false matchHeader: false matchQueryParams: true matchWildcards: true delay: null serverResponseId: 9a291bbe-dc0a-44ba-a3c8-6dbd06a61460 createdAt: '2022-06-09T19:38:06.000Z' updatedAt: '2022-06-13T18:55:25.000Z' environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e updateMockDeactivateServerResponse: value: mock: id: e3d951bf-873f-49ac-a658-b2dcb91d3289 owner: '12345678' uid: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289 collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 mockUrl: https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io name: Test Mock config: headers: [] matchBody: false matchHeader: false matchQueryParams: true matchWildcards: true delay: null serverResponseId: null createdAt: '2022-06-09T19:38:06.000Z' updatedAt: '2022-06-13T18:55:25.000Z' environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e getMock: value: mock: id: e3d951bf-873f-49ac-a658-b2dcb91d3289 owner: '12345678' uid: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289 collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 mockUrl: https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io name: Test Mock config: headers: [] matchBody: false matchHeader: false matchQueryParams: true matchWildcards: true delay: type: fixed duration: 140000 serverResponseId: 94d0f5d9-dbdf-4046-9a7d-a11f9b78ac65 createdAt: '2022-07-25T20:54:30.000Z' updatedAt: '2022-07-25T20:54:30.000Z' isPublic: false deactivated: false environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e mock404ErrorInstanceNotFound: value: error: name: instanceNotFoundError message: The specified mock does not exist. details: {} updateMock: value: mock: name: Test Mock environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e description: This is a test mock server. collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 private: true versionTag: abf07d3d-f8ec-47d4-8015-9fe83078b4ec updateMockCollectionEnvironment: value: mock: environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 mock400ErrorCreateMissingCollection: value: error: name: paramMissingError message: Parameter is missing in the request. details: param: - collection mock400ErrorCollectionApiError: value: error: name: workspaceError message: Can't create mock servers on a collection added to an API mock400ErrorAlreadyPublished: value: error: name: mockAlreadyPublishedError message: This mock is already public. mock400ErrorAlreadyUnpublished: value: error: name: mockAlreadyUnpublishedError message: This mock has already been deleted. mock400ErrorLogRetentionPeriodExceeded: value: error: name: invalidParamsError message: 'Invalid value for parameter: since. Cannot view logs beyond the call log retention period based on your plan i.e. 30 days.' mock400ErrorPutMissingParam: value: error: details: param: environment, private, name, config, collection name: paramMissingError message: At least one parameter must be provided. deleteMock: value: mock: id: 0fca2246-c108-41f5-8454-cc032def329f uid: 1679925-0fca2246-c108-41f5-8454-cc032def329f getMockCallLogs: value: call-logs: - id: c4505a1e-7261-497c-91ff-db4bd51351a6-9545 responseName: Double check your method and the request path and try again. servedAt: '2022-01-17T06:19:30.000Z' request: method: POST path: /animals response: type: error statusCode: 404 - id: 0f63f54d-665e-436a-95b4-c1302d7685a9-3925 responseName: Bad request servedAt: '2022-01-17T06:19:22.000Z' request: method: POST path: /animals response: type: success statusCode: 400 - id: adab0d30-5c38-43bf-af90-4119925138e2-3795 responseName: Successful addition of animals to the store servedAt: '2022-01-17T06:19:16.000Z' request: method: POST path: /animals response: type: success statusCode: 200 - id: dae50669-f4c1-460a-b3a4-3a2445f4f39d-2468 responseName: Get filtered list of Animals servedAt: '2022-01-17T06:18:26.000Z' request: method: GET path: /animals?type=dog response: type: success statusCode: 200 - id: a5330463-26e1-4812-a962-e44b569a2054-9894 responseName: Get Animals servedAt: '2022-01-17T06:18:06.000Z' request: method: GET path: /animals response: type: success statusCode: 200 meta: nextCursor: null getMockCallLogsFilterByLimit: value: call-logs: - id: c4505a1e-7261-497c-91ff-db4bd51351a6-9545 responseName: Double check your method and the request path and try again. servedAt: '2022-01-17T06:19:30.000Z' request: method: POST path: /animals response: type: error statusCode: 404 - id: 0f63f54d-665e-436a-95b4-c1302d7685a9-3925 responseName: Bad request servedAt: '2022-01-17T06:19:22.000Z' request: method: POST path: /animals response: type: success statusCode: 400 meta: nextCursor: eyJzY2hlbWUiOiJjdXJzb3JfcGFnaW5hdGlvbklkIiwiZGlyZWN0aW9uVHlwZSI6Im5leHQiLCJwaXZvdCI6InBhZ2luYXRpb25JZCIsInZhbHVlIjoxNjQyNDAwMzU2MDAwNTc5fQ== getMockCallLogsFilterByCursor: value: call-logs: - id: adab0d30-5c38-43bf-af90-4119925138e2-3795 responseName: Successful addition of animals to the store servedAt: '2022-01-17T06:19:16.000Z' request: method: POST path: /animals response: type: success statusCode: 200 - id: dae50669-f4c1-460a-b3a4-3a2445f4f39d-2468 responseName: Get filtered list of Animals servedAt: '2022-01-17T06:18:26.000Z' request: method: GET path: /animals?type=dog response: type: success statusCode: 200 - id: a5330463-26e1-4812-a962-e44b569a2054-9894 responseName: Get Animals servedAt: '2022-01-17T06:18:06.000Z' request: method: GET path: /animals response: type: success statusCode: 200 meta: nextCursor: null getMockCallLogsFilterByDateRange: value: call-logs: - id: c4505a1e-7261-497c-91ff-db4bd51351a6-9545 responseName: Double check your method and the request path and try again. servedAt: '2022-01-17T06:19:30.000Z' request: method: POST path: /animals response: type: error statusCode: 404 - id: 0f63f54d-665e-436a-95b4-c1302d7685a9-3925 responseName: Bad request servedAt: '2022-01-17T06:19:22.000Z' request: method: POST path: /animals response: type: success statusCode: 400 - id: adab0d30-5c38-43bf-af90-4119925138e2-3795 responseName: Successful addition of animals to the store servedAt: '2022-01-17T06:19:16.000Z' request: method: POST path: /animals response: type: success statusCode: 200 - id: dae50669-f4c1-460a-b3a4-3a2445f4f39d-2468 responseName: Get filtered list of Animals servedAt: '2022-01-17T06:18:26.000Z' request: method: GET path: /animals?type=dog response: type: success statusCode: 200 - id: a5330463-26e1-4812-a962-e44b569a2054-9894 responseName: Get Animals servedAt: '2022-01-17T06:18:06.000Z' request: method: GET path: /animals response: type: success statusCode: 200 meta: nextCursor: null getMockCallLogsFilterByDateSince: value: call-logs: - id: c4505a1e-7261-497c-91ff-db4bd51351a6-9545 responseName: Double check your method and the request path and try again. servedAt: '2022-01-17T06:19:30.000Z' request: method: POST path: /animals response: type: error statusCode: 404 - id: 0f63f54d-665e-436a-95b4-c1302d7685a9-3925 responseName: Bad request servedAt: '2022-01-17T06:19:22.000Z' request: method: POST path: /animals response: type: success statusCode: 400 - id: adab0d30-5c38-43bf-af90-4119925138e2-3795 responseName: Successful addition of animals to the store servedAt: '2022-01-17T06:19:16.000Z' request: method: POST path: /animals response: type: success statusCode: 200 meta: nextCursor: null getMockCallLogsFilterByResponseStatusCode: value: call-logs: - id: adab0d30-5c38-43bf-af90-4119925138e2-3795 responseName: Successful addition of animals to the store servedAt: '2022-01-17T06:19:16.000Z' request: method: POST path: /animals response: type: success statusCode: 200 - id: dae50669-f4c1-460a-b3a4-3a2445f4f39d-2468 responseName: Get filtered list of Animals servedAt: '2022-01-17T06:18:26.000Z' request: method: GET path: /animals?type=dog response: type: success statusCode: 200 - id: a5330463-26e1-4812-a962-e44b569a2054-9894 responseName: Get Animals servedAt: '2022-01-17T06:18:06.000Z' request: method: GET path: /animals response: type: success statusCode: 200 meta: nextCursor: null getMockCallLogsFilterByResponseType: value: call-logs: - id: 0f63f54d-665e-436a-95b4-c1302d7685a9-3925 responseName: Bad request servedAt: '2022-01-17T06:19:22.000Z' request: method: POST path: /animals response: type: error statusCode: 400 - id: adab0d30-5c38-43bf-af90-4119925138e2-3795 responseName: Successful addition of animals to the store servedAt: '2022-01-17T06:19:16.000Z' request: method: POST path: /animals response: type: success statusCode: 200 - id: dae50669-f4c1-460a-b3a4-3a2445f4f39d-2468 responseName: Get filtered list of Animals servedAt: '2022-01-17T06:18:26.000Z' request: method: GET path: /animals?type=dog response: type: success statusCode: 200 - id: a5330463-26e1-4812-a962-e44b569a2054-9894 responseName: Get Animals servedAt: '2022-01-17T06:18:06.000Z' request: method: GET path: /animals response: type: success statusCode: 200 meta: nextCursor: null getMockCallLogsFilterByRequestMethod: value: call-logs: - id: c4505a1e-7261-497c-91ff-db4bd51351a6-9545 responseName: Double check your method and the request path and try again. servedAt: '2022-01-17T06:19:30.000Z' request: method: POST path: /animals response: type: error statusCode: 404 - id: 0f63f54d-665e-436a-95b4-c1302d7685a9-3925 responseName: Bad request servedAt: '2022-01-17T06:19:22.000Z' request: method: POST path: /animals response: type: success statusCode: 400 - id: adab0d30-5c38-43bf-af90-4119925138e2-3795 responseName: Successful addition of animals to the store servedAt: '2022-01-17T06:19:16.000Z' request: method: POST path: /animals response: type: success statusCode: 200 meta: nextCursor: null getMockCallLogsFilterByRequestPath: value: call-logs: - id: dae50669-f4c1-460a-b3a4-3a2445f4f39d-2468 responseName: Get filtered list of Animals servedAt: '2022-01-17T06:18:26.000Z' request: method: GET path: /animals?type=dog response: type: success statusCode: 200 meta: nextCursor: null getMockCallLogsSortByServedAt: value: call-logs: - id: a5330463-26e1-4812-a962-e44b569a2054-9894 responseName: Get Animals servedAt: '2022-01-17T06:18:06.000Z' request: method: GET path: /animals response: type: success statusCode: 200 - id: dae50669-f4c1-460a-b3a4-3a2445f4f39d-2468 responseName: Get filtered list of Animals servedAt: '2022-01-17T06:18:26.000Z' request: method: GET path: /animals?type=dog response: type: success statusCode: 200 - id: adab0d30-5c38-43bf-af90-4119925138e2-3795 responseName: Successful addition of animals to the store servedAt: '2022-01-17T06:19:16.000Z' request: method: POST path: /animals response: type: success statusCode: 200 - id: 0f63f54d-665e-436a-95b4-c1302d7685a9-3925 responseName: Bad request servedAt: '2022-01-17T06:19:22.000Z' request: method: POST path: /animals response: type: success statusCode: 400 - id: c4505a1e-7261-497c-91ff-db4bd51351a6-9545 responseName: Double check your method and the request path and try again. servedAt: '2022-01-17T06:19:30.000Z' request: method: POST path: /animals response: type: error statusCode: 404 meta: nextCursor: null getMockCallLogsFilterByHeaderAndBody: value: call-logs: - id: c4505a1e-7261-497c-91ff-db4bd51351a6-9545 responseName: Double check your method and the request path and try again. servedAt: '2022-01-17T06:19:30.000Z' request: method: POST path: /animals headers: - key: content-length value: '50' - key: x-mock-match-request-body value: 'true' - key: content-type value: application/json body: mode: raw data: '{"type":"hamster","breed":"Syrian Hamster"}' response: type: error statusCode: 404 headers: [] body: data: '{"error":{"name":"mockRequestNotFoundError","message":"Double check your method and the request path and try again."}}' - id: 0f63f54d-665e-436a-95b4-c1302d7685a9-3925 responseName: Bad request servedAt: '2022-01-17T06:19:22.000Z' request: method: POST path: /animals headers: - key: content-length value: '69' - key: x-mock-match-request-body value: 'true' - key: content-type value: application/json body: mode: raw data: '{"type":"hamster","breed":"Syrian Hamster","age":"1 month"}' response: type: success statusCode: 400 headers: - description: content: '' type: text/plain key: Content-Type value: application/json body: data: "{\n\t\"message\": \"Malformed request. You need to send gender as part of the request.\"\n}" - id: adab0d30-5c38-43bf-af90-4119925138e2-3795 responseName: Successful addition of animals to the store servedAt: '2022-01-17T06:19:16.000Z' request: method: POST path: /animals headers: - key: content-length value: '88' - key: x-mock-match-request-body value: 'true' - key: content-type value: application/json body: mode: raw data: '{"type":"hamster","breed":"Syrian Hamster","age":"1 month","gender":"male"}' response: type: success statusCode: 200 headers: - description: content: '' type: text/plain key: Content-Type value: application/json body: data: "{\n\t\"message\": \"Animal added successfully to the store\"\n}" - id: dae50669-f4c1-460a-b3a4-3a2445f4f39d-2468 responseName: Get filtered list of Animals servedAt: '2022-01-17T06:18:26.000Z' request: method: GET path: /animals?type=dog headers: [] body: {} response: type: success statusCode: 200 headers: - description: content: '' type: text/plain key: Content-Type value: application/json body: data: "[\n\t{\n\t\t\"type\": \"dog\",\n\t\t\"breed\": \"German Sheperd\",\n\t\t\"age\": \"6 months\",\n\t\t\"gender\": \"male\"\n\t},\n\t{\n\t\t\"type\": \"dog\",\n\t\t\"breed\": \"Bulldog\",\n\t\t\"age\": \"1 year\",\n\t\t\"gender\": \"female\"\n\t}\n]" - id: a5330463-26e1-4812-a962-e44b569a2054-9894 responseName: Get Animals servedAt: '2022-01-17T06:18:06.000Z' request: method: GET path: /animals headers: [] body: {} response: type: success statusCode: 200 headers: - description: content: '' type: text/plain key: Content-Type value: application/json body: data: "[\n\t{\n\t\t\"type\": \"dog\",\n\t\t\"breed\": \"German Sheperd\",\n\t\t\"age\": \"6 months\",\n\t\t\"gender\": \"male\"\n\t},\n\t{\n\t\t\"type\": \"dog\",\n\t\t\"breed\": \"Bulldog\",\n\t\t\"age\": \"1 year\",\n\t\t\"gender\": \"female\"\n\t},\n\t{\n\t\t\"type\": \"cat\",\n\t\t\"breed\": \"Persian cat\",\n\t\t\"age\": \"3 months\",\n\t\t\"gender\": \"female\"\n\t}\n]" meta: nextCursor: null publishUnpublishMockResponse: value: mock: id: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289 getMockServerResponses: value: - id: 965cdd16-fe22-4d96-a161-3d05490ac421 name: Internal Server Error statusCode: 500 createdAt: '2022-08-02T14:57:44.000Z' updatedAt: '2022-08-02T14:57:44.000Z' createdBy: '12345678' updatedBy: '12345678' mockServerResponse404ErrorMockNotFound: value: error: name: mockNotFoundError header: Unable to find mock message: Please refresh and try again. mockServerResponse404ErrorServerResponseNotFound: value: error: name: serverResponseNotFoundError header: Unable to find mock server response message: We could not find the mock server response you are looking for. createMockServerResponse: value: serverResponse: name: Internal Server Error statusCode: 500 headers: - key: Content-Type value: application/json language: json body: |- { "message": "Something went wrong; try again later." } mockServerResponse: value: createdAt: '2022-08-02T15:08:03.000Z' updatedAt: '2022-08-02T15:08:03.000Z' id: 965cdd16-fe22-4d96-a161-3d05490ac421 name: Internal Server Error statusCode: 500 headers: [] language: null body: |- { "message": "Something went wrong; try again later." } createdBy: '20891195' updatedBy: '20891195' mock: 32cd624d-9986-4f20-9048-89252f722269 updateMockServerResponse: value: serverResponse: name: Internal Server Error statusCode: 500 headers: - key: Content-Type value: application/json language: json body: |- { "message": "Something went wrong; try again later." } deleteMockServerResponse: value: id: bf6bbf95-bebb-44ba-8edb-1f096f905774 name: Service Unavailable statusCode: 503 headers: - key: Content-Type value: application/json language: json body: |- { "message": "Service is temporarily unavailable due to maintenance. If the problem persists, reach out to support." } createdBy: '12345678' updatedBy: '12345678' createdAt: '2022-05-02T09:38:04.000Z' getMonitors: value: monitors: - id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: Test Monitor active: true uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 owner: 12345678 collectionUid: 12345678-d35c5bfa-380e-4e98-9052-4eaf3bd0f14a environmentUid: 12345678-9ce0605e-e7cb-40dc-8074-2f6a69252905 - id: 1e6b6cb7-f13d-4000-acb7-0695757174a8 name: Postman Echo Monitor active: true uid: 87654321-1e6b6cb7-f13d-4000-acb7-0695757174a8 owner: 87654321 collectionUid: 87654321-b2f818c8-0ff3-4b54-8922-4525dd7acaf7 environmentUid: 87654321-a674962b-feeb-475d-a796-c59dd4ee28a7 meta: nextCursor: '' limit: 25 getMonitorsInWorkspace: value: monitors: - id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: Test Monitor active: true uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 owner: 12345678 collectionUid: 12345678-d35c5bfa-380e-4e98-9052-4eaf3bd0f14a environmentUid: 12345678-9ce0605e-e7cb-40dc-8074-2f6a69252905 meta: nextCursor: '' limit: 25 getMonitorsFilterByCollectionUid: value: monitors: - id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: Test Monitor active: true uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 owner: 12345678 collectionUid: 12345678-d35c5bfa-380e-4e98-9052-4eaf3bd0f14a environmentUid: 12345678-9ce0605e-e7cb-40dc-8074-2f6a69252905 meta: nextCursor: '' limit: 25 getMonitorsFilterByEnvironmentUid: value: monitors: - id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: Test Monitor active: true uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 owner: 12345678 collectionUid: 12345678-d35c5bfa-380e-4e98-9052-4eaf3bd0f14a environmentUid: 12345678-9ce0605e-e7cb-40dc-8074-2f6a69252905 meta: nextCursor: '' limit: 25 getMonitorsActiveFilter: value: monitors: - id: 3d08e460-b58f-4f46-9dbb-018c57760864 name: Billing active: false uid: 56781234-3d08e460-b58f-4f46-9dbb-018c57760864 owner: 56781234 collectionUid: 56781234-b79c429b-b347-4b9c-a969-9cc3e1349f68 environmentUid: 56781234-ec29504a-a305-47b2-9c73-8b0dcd6ddd61 - id: 5c8ff94d-ae04-4f23-812c-d428fa72bc43 name: API Test 2 active: false uid: 87654321-5c8ff94d-ae04-4f23-812c-d428fa72bc43 owner: 87654321 collectionUid: 87654321-01c3b7c7-bf1e-47ab-8d57-0f9f950dca65 environmentUid: 87654321-2ff3607d-2bdc-49a4-91af-40b0f48a0c77 meta: nextCursor: '' limit: 25 getMonitorsOwnerFilter: value: monitors: - id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: Test Monitor active: true uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 owner: 12345678 collectionUid: 12345678-d35c5bfa-380e-4e98-9052-4eaf3bd0f14a environmentUid: 12345678-9ce0605e-e7cb-40dc-8074-2f6a69252905 - id: 90e01576-3ec4-4245-a327-e56b78becdce name: Testing Monitor active: true uid: 12345678-90e01576-3ec4-4245-a327-e56b78becdce owner: 12345678 collectionUid: 12345678-ecfd0f2c-cf60-4935-b2ed-b65c58d2910c environmentUid: 12345678-106dabbe-324c-488f-b628-c9f45033dcc7 meta: nextCursor: '' limit: 25 getMonitorsLimitCursorPagination: value: monitors: - id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: Test Monitor active: true uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 owner: 12345678 collectionUid: 12345678-d35c5bfa-380e-4e98-9052-4eaf3bd0f14a environmentUid: 12345678-9ce0605e-e7cb-40dc-8074-2f6a69252905 - id: 1e6b6cb7-f13d-4000-acb7-0695757174a8 name: API Test active: true uid: 87654321-1e6b6cb7-f13d-4000-acb7-0695757174a8 owner: 87654321 collectionUid: 87654321-2f5e0f30-15f9-4c8a-9371-bb4402149abb environmentUid: 87654321-da11b6bf-1856-4625-ade2-46843b8eb31c - id: 3d08e460-b58f-4f46-9dbb-018c57760864 name: Billing active: false uid: 56781234-3d08e460-b58f-4f46-9dbb-018c57760864 owner: 56781234 collectionUid: 56781234-b79c429b-b347-4b9c-a969-9cc3e1349f68 environmentUid: 56781234-ec29504a-a305-47b2-9c73-8b0dcd6ddd61 - id: 90e01576-3ec4-4245-a327-e56b78becdce name: Testing Monitor active: true uid: 12345678-90e01576-3ec4-4245-a327-e56b78becdce owner: 12345678 collectionUid: 12345678-ecfd0f2c-cf60-4935-b2ed-b65c58d2910c environmentUid: 12345678-106dabbe-324c-488f-b628-c9f45033dcc7 - id: 5c8ff94d-ae04-4f23-812c-d428fa72bc43 name: API Test 2 active: false uid: 87654321-5c8ff94d-ae04-4f23-812c-d428fa72bc43 owner: 87654321 collectionUid: 87654321-01c3b7c7-bf1e-47ab-8d57-0f9f950dca65 environmentUid: 87654321-2ff3607d-2bdc-49a4-91af-40b0f48a0c77 meta: nextCursor: D7TopGzwFnQtrVmj8QRbSBsBKkHAq19dnoRp5XxKVfVJW4pUx74P3L9BW9qTnR8vhAbgmXA3KEBTSG8Y4BXxJDmU8vJMH76RfKF1f51DfYm2qgt14AK1oLX1mj5qcmH2buYxiPL5CmdyktVVmNqs9zsMtLD9 limit: 5 getMonitorsOwnerNotFound: value: monitors: [] meta: nextCursor: '' limit: 25 getMonitorsCollectionNotFound: value: monitors: [] meta: nextCursor: '' limit: 25 getMonitorsEnvironmentNotFound: value: monitors: [] meta: nextCursor: '' limit: 25 createMonitor400ErrorForbidden: value: error: name: forbiddenError message: You need read access to this collection in order to perform this action. getMonitors400ErrorInvalidActive: value: error: name: badRequest message: Active must be a boolean. monitors400ErrorInvalidCollectionUid: value: error: name: invalidUidError message: The specified uid is invalid. details: param: collection uid: 12ece9e1-2abf-4edc-8e34-de66e74114d2 monitors400ErrorInvalidCronPattern: value: error: name: cronPatternNotAllowedError message: Invalid cron pattern. Enter a valid cron pattern, such as "0 17 * * *" details: pattern: '* * * * *' getMonitors400ErrorInvalidCursor: value: error: name: badRequest message: Invalid cursor query parameter passed. monitors400ErrorInvalidEnvironmentUid: value: error: name: invalidUidError message: The specified uid is invalid. details: param: environment uid: 5daabc50-8451-43f6-922d-96b403b4f28e getMonitors400ErrorInvalidOwner: value: error: name: badRequest message: Owner user ID must be an integer. getMonitors400ErrorInvalidPagination: value: error: name: badRequest message: Query param limit cannot exceed 25. updateMonitor400ErrorInvalidParameters: value: error: name: parameterNotAllowedError message: The specified parameter cannot be updated. details: param: - collection - environment monitors400ErrorInvalidTimezone: value: error: name: invalidParamsError message: The request had invalid parameters details: param: schedule.timezone getMonitors400ErrorInvalidWorkspace: value: error: name: badRequest message: Workspace ID must be 36 characters (37). monitors400ErrorMissingParameter: value: error: name: paramMissingError message: Parameter is missing in the request. details: param: - name updateMonitor400ErrorMissingParameter: value: error: name: paramMissingError message: Parameter is missing in the request. details: param: - cron monitors404ErrorInstanceNotFoundMonitor: value: error: name: instanceNotFoundError message: The specified monitor does not exist. monitors404ErrorMonitorIdNotFound: value: error: name: instanceNotFoundError message: Monitor 1e6b6cb7-f13d-4000-acb7-0695757174a8 does not exist. monitors404ErrorWorkspaceNotFound: value: error: name: instanceNotFoundError message: Workspace not found monitorCreate: value: monitor: name: Test Monitor active: true notificationLimit: 2 collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 environment: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e retry: attempts: 1 schedule: cron: '*/5 * * * *' timezone: America/Chicago options: strictSSL: true followRedirects: false requestTimeout: 4000 requestDelay: 5 notifications: onError: - email: taylor.lee@example.com onFailure: [] distribution: - region: us-east - region: ca-central - region: us-west createUpdateMonitorResponse: value: monitor: id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: Test Monitor active: true uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 createMonitorWithOptionsResponse: value: monitor: id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: Test Monitor active: true uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 getMonitor: value: monitor: id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: Test Monitor uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 owner: 12345678 active: true notificationLimit: 1 collectionUid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 environmentUid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e options: strictSSL: true followRedirects: true requestTimeout: 3000 requestDelay: 1 notifications: onError: - email: taylor.lee@example.com onFailure: - email: taylor.lee@example.com distribution: - region: us-east schedule: cron: 0 0 * * * * timezone: America/Chicago nextRun: '2025-06-18T05:00:00.000Z' retry: attempts: 1 lastRun: status: success startedAt: '2025-06-17T18:39:52.852Z' finishedAt: '2025-06-17T18:39:53.707Z' jobId: e72dc3de-e4ac-407c-b1cc-2c5b6efced68 stats: assertions: total: 5 failed: 0 requests: total: 3 runCount: 42 errorCount: 0 abortedCount: 2 responseLatency: 850 responseSize: 2048 monitorUpdate: value: monitor: name: Test Monitor notificationLimit: 1 retry: attempts: 2 schedule: cron: '*/5 * * * *' timezone: America/Chicago options: strictSSL: false followRedirects: true requestTimeout: 5000 requestDelay: 1 notifications: onError: - email: taylor.lee@example.com onFailure: - email: taylor.lee@example.com distribution: - region: ca-central monitorPause: value: monitor: active: false monitorResume: value: monitor: active: true updateMonitorPauseResponse: value: monitor: id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: Test Monitor active: false uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 updateMonitorResumeResponse: value: monitor: id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: Test Monitor active: true uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 deleteMonitor: value: monitor: id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 uid: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 runMonitor: value: run: info: jobId: 1ecee76a-e14e-47c0-bddc-256bf690c407 monitorId: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: Test Monitor collectionUid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 environmentUid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e status: success startedAt: '2025-06-17T19:50:04.019Z' finishedAt: '2025-06-17T19:50:06.439Z' stats: assertions: total: 5 failed: 0 requests: total: 3 failed: 0 runCount: 3 errorCount: 2 abortedCount: 1 responseLatency: 850 responseSize: 2048 executions: - id: 1 item: name: Sample POST Request request: method: POST url: http://echo.getpostman.com/post headers: Content-Type: application/json User-Agent: PostmanRuntime/7.29.0 Accept: '*/*' Cache-Control: no-cache Postman-Token: null Host: echo.getpostman.com Accept-Encoding: gzip, deflate, br Connection: keep-alive Content-Length: '0' body: contentLength: 0 timestamp: '2025-06-17T19:50:06.186Z' response: code: 200 body: contentLength: 50 responseTime: 49 responseSize: 50 headers: Date: Fri, 17 Jun 2025 19:50:06 GMT Content-Type: text/plain Content-Length: '50' Connection: keep-alive Server: null failures: [] runMonitorAsyncParam: value: run: info: jobId: 1ecee76a-e14e-47c0-bddc-256bf690c407 monitorId: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: Test Monitor collectionUid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 environmentUid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e status: success startedAt: '2022-06-17T19:50:04.019Z' finishedAt: '2022-06-17T19:50:06.439Z' runMonitorFailedResponse: value: run: info: jobId: 1ecee76a-e14e-47c0-bddc-256bf690c407 monitorId: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: Test Monitor collectionUid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 environmentUid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e status: failed startedAt: '2022-06-17T20:00:41.659Z' finishedAt: '2022-06-17T20:00:42.693Z' stats: assertions: total: 1 failed: 1 requests: total: 1 failed: 0 executions: - id: 1 item: name: Sample POST Request request: method: POST url: http://echo.getpostman.com/post headers: Content-Type: application/json User-Agent: PostmanRuntime/7.29.0 Accept: '*/*' Cache-Control: no-cache Postman-Token: null Host: echo.getpostman.com Accept-Encoding: gzip, deflate, br Connection: keep-alive Content-Length: '0' body: contentLength: 0 timestamp: '2022-06-17T20:00:42.423Z' response: code: 200 body: contentLength: 50 responseTime: 15 responseSize: 50 headers: Date: Fri, 17 Jun 2022 20:00:42 GMT Content-Type: text/plain Content-Length: '50' Connection: keep-alive Server: null failures: [] runMonitorWithErrorsResponse: value: run: info: jobId: 1ecee76a-e14e-47c0-bddc-256bf690c407 monitorId: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: Test Monitor collectionUid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 environmentUid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e status: error startedAt: '2022-06-17T20:04:47.183Z' finishedAt: '2022-06-17T20:04:48.858Z' stats: assertions: total: 4 failed: 2 requests: total: 4 failed: 3 executions: - id: 1 item: name: Sample GET Request request: method: GET url: https://example.com/search?format=json&state=&city=&country= headers: User-Agent: PostmanRuntime/7.29.0 Accept: '*/*' Cache-Control: no-cache Postman-Token: null Host: example.com Accept-Encoding: gzip, deflate, br Connection: keep-alive body: contentLength: 0 timestamp: '2022-06-17T20:04:47.926Z' response: code: 200 body: contentLength: 2 responseTime: 257 responseSize: 2 headers: Server: null Date: Fri, 17 Jun 2022 20:04:47 GMT Content-Type: application/json; charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Keep-Alive: null Access-Control-Allow-Origin: '*' Access-Control-Allow-Methods: OPTIONS,GET errors: - name: m message: Cannot read property 'lat' of undefined failures: - executionId: 1 name: TypeError message: Cannot read property 'lat' of undefined runMonitor202: value: run: info: monitorId: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 status: running message: The request is taking longer than expected, but is processing. To avoid this in future requests, pass the 'async=true' query parameter to use the async option. getPanElements: value: elements: - addedAt: '2024-11-29T06:31:24.000Z' addedBy: 12345678 createdBy: 12345678 createdAt: '2024-11-29T06:31:24.000Z' updatedBy: 12345678 updatedAt: '2024-11-29T06:31:24.000Z' type: workspace id: 5360b75f-447e-467c-9299-12fd6c92450d parentFolderId: 0 name: Billing Team Workspace summary: The Billing team's workspace. description: null href: https://api.postman.com/workspaces/1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 - addedAt: '2024-11-29T06:31:26.000Z' addedBy: 12345678 createdBy: 12345678 createdAt: '2024-11-29T06:31:26.000Z' updatedBy: 12345678 updatedAt: '2024-11-29T06:31:26.000Z' type: workspace id: 360b75f-447e-467c-9299-12fd3c92450d parentFolderId: 0 name: Test Workspace summary: This is a test workspace. description: null href: https://api.postman.com/workspaces/41f6dc6d-d8ab-45c6-8506-74a25acf5d5f folders: [] meta: limit: 1000 offset: 0 totalCount: 2 postPanWorkspace: value: workspace: id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 panElementCreated: value: addedAt: '2024-12-07T17:59:23.000Z' addedBy: 12345678 createdBy: 12345678 createdAt: '2024-12-07T17:59:23.000Z' updatedBy: 12345678 updatedAt: '2024-12-07T17:59:23.000Z' type: workspace id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: Billing Team Workspace summary: The Billing team's workspace. description: null href: https://api.postman.com/workspaces/1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 parentFolderId: null pan404ErrorElement: value: name: instanceNotFoundError message: Instance not found for the model NetworkEntity, id 5360b75f-447e-467c-9299-12fd6c92450d updatePanWorkspace: value: workspace: parentFolderId: 0 deletePanElement: value: workspace: id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 pan400ErrorInvalidParams: value: name: invalidParamsError message: Status type can only be denied or approved. pan400ErrorInvalidQueryParams: value: name: invalidParamsError message: The specified request does not exist. pan400ErrorNotFoundRequestId: value: name: RequestNotFound message: No request found for the corresponding ID pan400ErrorElementAlreadyPublished: value: name: requestEntityAlreadyPublished message: Billing Team Workspace has already been published to the network pan400ErrorAlreadyResponded: value: name: requestAlreadyResponded message: This request is already responded. getAllPanAddElementRequests: value: requests: - id: 1 createdBy: 87654321 createdAt: '2024-06-01T08:32:31.000Z' status: pending element: type: workspace id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: Billing Team Workspace summary: The Billing team's workspace. - id: 2 createdBy: 56781234 createdAt: '2024-06-09T14:48:45.000Z' message: Please approve this workspace status: denied element: type: workspace id: 360b75f-447e-467c-9299-12fd3c92450d name: Test Workspace summary: This is a test workspace. response: createdAt: '2024-06-01T08:32:31.000Z' createdBy: 12345678 message: Too many errors, please fix and resubmit meta: limit: 2 offset: 0 totalCount: 10 respondPanElementAddRequestApprove: value: status: approved respondPanElementAddRequestDeny: value: status: denied response: message: Please fix the API issues first. respondPanElementAddRequestApproveResponse: value: request: - id: 2 createdAt: '2024-06-09T14:48:45.000Z' createdBy: 87654321 message: Please add this to the network status: approved element: id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: Billing Team Workspace summary: The Billing team's workspace. description: null type: workspace createdBy: 12345678 createdAt: '2024-06-19T04:48:40.000Z' respondPanElementAddRequestDenyResponse: value: request: - id: 2 createdAt: '2024-06-09T14:48:45.000Z' createdBy: 87654321 message: Please add this to the network status: denied element: type: workspace id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: Billing Team Workspace summary: The Billing team's workspace. response: createdAt: '2024-06-19T04:48:40.000Z' createdBy: 12345678 message: Please fix the API issues first. generateOauthToken: value: grant_type: client_credentials installationAuthId: e868878e40f646ce8b5620736995dc89 jwt: eyJhXXX generateOauthTokenResponse: value: access_token: PMAK-XXX expires_in: 3600 token_type: Bearer oauthToken400ErrorUnsupportedGrantType: value: error: invalid_request error_description: Unsupported grant type oauthToken404ErrorClientInstallationNotFound: value: error: invalid_client error_description: OAuth client installation not found oauthToken404ErrorOAuthClientNotFound: value: error: invalid_client error_description: OAuth client not found oauthToken404ErrorTokenNotFound: value: error: invalid_client error_description: Token not found revokeOauthToken: value: token: PMAK-XXX revokeOauthTokenResponse: value: success: 'true' getPackages: value: meta: nextCursor: null data: - id: 018d8463-4d17-7568-871f-5bd24dd45868 name: my-utils description: Shared utility scripts createdAt: '2026-07-24T10:30:00.000Z' updatedAt: '2026-07-24T10:30:00.000Z' packages400ErrorInvalidFormatLength: value: type: https://api.postman.com/problems/bad-request title: The request is invalid or improperly formatted. instance: /packages/3b60f5f3-cd98-4e04-b560-3eb039fe85d8 status: 400 detail: Blob ID must be 36 characters (6). packages401ErrorUnauthorized: value: type: https://api.postman.com/problems/unauthorized title: You are not authenticated by the server. instance: /packages status: 401 detail: You are not authenticated by the server. packages403ErrorForbidden: value: type: https://api.postman.com/problems/forbidden title: You do not have the permissions to perform this action. instance: /packages status: 403 detail: You need to be a member of this team to view this package. packages429ErrorRateLimitExceeded: value: type: https://api.postman.com/problems/rate-limit-exceeded title: You've reached the limit for your plan instance: /packages status: 429 detail: You've reached the limit for number of Packages. packages500ErrorInternalServerError: value: type: https://api.postman.com/problems/internal-server-error title: Something went wrong with the server. instance: /packages status: 500 detail: Something went wrong with the server. createPackage: value: name: my-math-package description: This package contains utility functions to do math. script: 'module.exports = { add: (a, b) => a + b };' createPackageResponse: value: id: 3b60f5f3-cd98-4e04-b560-3eb039fe85d8 name: my-math-package description: This package contains utility functions to do math. script: 'module.exports = { add: (a, b) => a + b };' createdBy: 12345678 createdAt: '2026-08-01T20:11:17.000Z' updatedAt: '2026-08-01T20:11:17.000Z' packages409ErrorConflict: value: type: https://api.postman.com/problems/conflict title: The resource conflicts with an existing resource. instance: /packages status: 409 detail: A package with this name already exists. getPackageUnifiedPackage: value: id: 3b60f5f3-cd98-4e04-b560-3eb039fe85d8 name: my-math-package description: This package contains utility functions to do math. script: 'module.exports = { add: (a, b) => a + b };' createdBy: 12345678 createdAt: '2026-08-01T20:11:17.000Z' updatedAt: '2026-08-01T20:11:17.000Z' packages404ErrorBlobNotFound: value: type: https://api.postman.com/problems/not-found title: The resource you are trying to access does not exist. instance: /packages/3b60f5f3-cd98-4e04-b560-3eb039fe85d8 status: 404 detail: The blob 1ec6fb87-77a9-42b0-b3a1-14e54ad8b066 does not exist. packages404ErrorPackageNotFound: value: type: https://api.postman.com/problems/not-found title: The resource you are trying to access does not exist. instance: /packages/3b60f5f3-cd98-4e04-b560-3eb039fe85d8 status: 404 detail: The package 1ec6fb87-77a9-42b0-b3a1-14e54ad8b066 does not exist. updatePackage: value: description: Updated math utility functions. script: 'module.exports = { add: (a, b) => a + b };' updatePackageResponse: value: id: 3b60f5f3-cd98-4e04-b560-3eb039fe85d8 name: my-math-package description: Updated math utility functions. script: 'module.exports = { add: (a, b) => a + b };' createdBy: 12345678 createdAt: '2022-08-21T20:11:17.000Z' updatedAt: '2022-08-22T09:30:00.000Z' generateTool: value: collectionId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 requestId: c82dd02c-4870-4907-8fcb-593a876cf05b config: language: javascript agentFramework: openai generateToolResponse: value: data: text: |- /** * Function to query a Notion database. * * @param {Object} args - Arguments for the query. * @param {string} args.databaseId - The ID of the Notion database to query. * @param {Object} [args.filter] - The filter conditions for the query. * @param {Array} [args.sorts] - The sort conditions for the query. * @returns {Promise} - The result of the database query. */ const executeFunction = async ({ databaseId, filter, sorts }) => { // NOTE before using the tool: verify this section is correct const baseUrl = `https://api.notion.com/v1/databases/${databaseId}/query`; // NOTE! Replace this with your actual API token const token = process.env.NOTION_API_TOKEN; const notionVersion = process.env.NOTION_VERSION || '2022-06-28'; // Default version, update as needed // Set up headers for the request const headers = { 'Authorization': `Bearer ${token}`, 'Content-Type': 'application/json', 'Notion-Version': notionVersion, }; const body = JSON.stringify({ filter, sorts, }); // Perform the fetch request const response = await fetch(baseUrl, { method: 'POST', headers, body }); // Check if the response was successful if (!response.ok) { const errorData = await response.json(); throw new Error(errorData); } // Parse and return the response data const data = await response.json(); return data; }; /** * Tool configuration for querying a Notion database. * @type {Object} */ const apiTool = { type: 'function', function: { name: 'query_notion_database', function: executeFunction, description: 'Query a Notion database using specific filter and sort parameters.', parse: JSON.parse, parameters: { type: 'object', properties: { databaseId: { type: 'string', description: 'The ID of the Notion database to query.', }, filter: { type: 'object', description: 'The filter conditions for the query.', }, sorts: { type: 'array', description: 'The sort conditions for the query.', items: { type: 'object', properties: { property: { type: 'string', description: 'The database property to sort by.', }, direction: { type: 'string', description: 'The direction of sorting, either "ascending" or "descending".', enum: ['ascending', 'descending'], }, }, }, }, }, required: ['databaseId'], additionalProperties: false, }, }, }; export default apiTool; postbot400ErrorBadRequest: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: '"body.config.agentFramework" must be one of [openai, mistral, gemini, anthropic, langchain, autogen]' postbot400ErrorCollectionNotFoundNotPublic: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: Collection does not exist or is not public postbot400ErrorInvalidFramework: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: '"\"body.config.agentFramework\" must be one of [openai, mistral, gemini, anthropic, langchain, autogen]"' postbot400ErrorInvalidLanguage: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: '"body.config.language" must be one of [javascript, typescript]' postbot400ErrorMissingProperty: value: type: https://api.postman.com/problems/bad-request status: 400 title: Missing property 'config' detail: 'POST request body for ''/postbot/generations/tool'' failed to validate schema. Location: /required' postbot400ErrorRequestNotFound: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: Request not found pullRequest409ErrorConflict: value: type: https://api.postman.com/problems/conflict title: Conflict status: 409 detail: You cannot modify a pull request which is already merged or declined. getRunnerInstances: value: meta: model: runnerInstance action: find url: https://testing.example.com/runners/1f08d6ba-c377-4ca0-be80-af81daf8fef9/instances data: - id: Rtesting-78b4f9c59c-5c7mx|b5862804ba|1.23.0|Linux hostname: testing-78b4f9c59c-5c7mx uniqueId: b5862804ba cliVersion: 1.23.0 osType: Linux runnerId: 1f08d6ba-c377-4ca0-be80-af81daf8fef9 lastPingedAt: '2025-11-06T14:59:53.000Z' - id: Rtesting-78b4f9c59c-bdjdr|f1b9f8f94a|1.23.0|Linux hostname: testing-78b4f9c59c-bdjdr uniqueId: f1b9f8f94a cliVersion: 1.23.0 osType: Linux runnerId: 1f08d6ba-c377-4ca0-be80-af81daf8fef9 lastPingedAt: '2025-11-06T15:30:51.000Z' - id: Rtesting-78b4f9c59c-g85wn|b35d23de98|1.23.0|Linux hostname: testing-78b4f9c59c-g85wn uniqueId: b35d23de98 cliVersion: 1.23.0 osType: Linux runnerId: 1f08d6ba-c377-4ca0-be80-af81daf8fef9 lastPingedAt: '2025-11-06T15:33:35.000Z' - id: Rtesting-78b4f9c59c-shf48|cd40b93f88|1.23.0|Linux hostname: testing-78b4f9c59c-shf48 uniqueId: cd40b93f88 cliVersion: 1.23.0 osType: Linux runnerId: 1f08d6ba-c377-4ca0-be80-af81daf8fef9 lastPingedAt: '2025-11-06T15:33:35.000Z' getRunnerInstancesCursorLimit: value: meta: nextCursor: 2NMbfiEAxQcpbmTFnmfQw7jV83WCRxjFxCwipofDVfn83ac16idLnRngzvpj4VNR5GsufwXVFrWX59iLNdV7CEriGGCutycbRD1smGoWV9F5GMLGs59mGQX5hnmnhsvxDLYt1kaJgkZYk6fs9oxoaqLvLbRSQb4LyBn4vkTh1T6Xvt1c8Pe9SPR2xJ5y3fPe6judViwg1CPLJbDdRNFZ6GJ8qDp26hJE8ZPTwoYrj model: runnerInstance action: find url: https://testing.example.com/runners/1f08d6ba-c377-4ca0-be80-af81daf8fef9/instances?limit=1 data: - id: Rtesting-78b4f9c59c-5c7mx|b5862804ba|1.23.0|Linux hostname: testing-78b4f9c59c-5c7mx uniqueId: b5862804ba cliVersion: 1.23.0 osType: Linux runnerId: 1f08d6ba-c377-4ca0-be80-af81daf8fef9 lastPingedAt: '2025-11-06T14:59:53.000Z' getRunnerInstancesNoData: value: meta: model: runnerInstance action: find url: https://testing.example.com/runners/1f08d6ba-c377-4ca0-be80-af81daf8fef9/instances data: [] runner400ErrorInvalidPaginationLimit: value: type: urn:error:monitor:badRequest title: The request is invalid or improperly formatted. detail: Query param limit cannot exceed 25. createdAt: '2025-11-06T08:55:38.790Z' runner404ErrorRunnerNotFound: value: detail: Runner not found. createdAt: '2025-11-06T14:14:45.934Z' title: Instance not found in the database. type: urn:error:monitor:instanceNotFoundError getRunnerMetrics: value: lastPingAt: '2025-09-21T12:11:19.000Z' oldestQueuedRunAgeSeconds: 10213 queueDepth: 9 getAllRulesets: value: data: - id: 01JABCDEF0123456789ABCDEFG name: api-style-guide description: Company-wide rules for API specifications. engine: spectral format: spectral type: custom createdBy: '12345678' updatedBy: '12345678' createdAt: '2026-07-13T10:15:30.000Z' updatedAt: '2026-07-13T11:20:00.000Z' meta: nextCursor: eyJvZmZzZXQiOjEwfQ== createRuleset: value: name: api-style-guide description: Company-wide rules for API specifications. engine: spectral format: spectral content: |- formats: - oas2 - oas3 - aas2 - aas3 rules: operation-operationId: true createRulesetResponse: value: id: 01JABCDEF0123456789ABCDEFG apiGovernance409ErrorRulesetNameConflict: value: type: https://api.postman.com/problems/conflict title: Conflict status: 409 detail: A ruleset with this name already exists. getRuleset: value: id: 01JABCDEF0123456789ABCDEFG name: api-style-guide description: Company-wide rules for API specifications. engine: spectral format: spectral type: custom createdBy: '12345678' updatedBy: '12345678' createdAt: '2026-07-13T10:15:30.000Z' updatedAt: '2026-07-13T11:20:00.000Z' getRulesetWithContent: value: id: 01JABCDEF0123456789ABCDEFG name: api-style-guide description: Company-wide rules for API specifications. engine: spectral format: spectral type: custom content: |- formats: - oas2 - oas3 - aas2 - aas3 rules: operation-operationId: true createdBy: '12345678' updatedBy: '12345678' createdAt: '2026-07-13T10:15:30.000Z' updatedAt: '2026-07-13T11:20:00.000Z' updateRulesetMetadata: value: name: API_Style_Guide_v2 description: Updated company-wide rules for API specifications. updateRulesetContent: value: content: |- rules: operation-operationId: true operation-description: true updateRulesetResponse: value: id: 01JABCDEF0123456789ABCDEFG getRulesetAssignments: value: data: - rulesetId: 01JABCDEF0123456789ABCDEFG targetType: governance_group targetId: 01JWSGROUP0123456789ABCDEF createRulesetAssignment: value: targetType: governance_group targetId: 01JWSGROUP0123456789ABCDEF createRulesetAssignmentResponse: value: rulesetId: 01JABCDEF0123456789ABCDEFG targetType: governance_group targetId: 01JWSGROUP0123456789ABCDEF apiGovernance409ErrorRulesetAssignmentConflict: value: type: https://api.postman.com/problems/conflict title: Conflict status: 409 detail: This ruleset is already assigned to the target governance group. deleteRulesetAssignmentResponse: value: {} getSecretTypes: value: meta: total: 4 data: - name: Postman Collection Key id: 04084949-0dda-4735-ace5-f83038f7b200 type: DEFAULT - name: Planetscale API Token id: 082351ca-810e-476b-8437-d098b20fba4b type: DEFAULT - name: Open AI API Key id: 0987c237-c1d0-4f07-a1af-a5772facf866 type: DEFAULT - name: Picatic API Key id: 0eac968d-f65e-4f3d-9a34-c02138072835 type: DEFAULT schemaSecurityValidationRequest: value: schema: type: openapi3 language: json schema: |- { "openapi": "3.0.0", "servers": [ { "url": "example.com" } ], "info": { "contact": { "name": "Jon" }, "version": "1.0.0", "title": "Sample API", "description": "Buy or rent spacecrafts" }, "paths": { "/spacecrafts/{spacecraftId}": { "parameters": [ { "name": "spacecraftId", "description": "The unique identifier of the spacecraft", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SpacecraftId" } } ], "get": { "summary": "Read a spacecraft", "responses": { "200": { "description": "The spacecraft corresponding to the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Spacecraft" } } } }, "404": { "description": "No spacecraft found for the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "#/components/schemas/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key" } } }, "security": [ { "ApiKey": [] } ] } schemaSecurityValidationNoWarnings: value: warnings: [] schemaSecurityValidationGovernanceWarnings: value: warnings: - slug: OPENAPI_SPECTRAL_6_RULE_1016 checksum: 5c17d7472a8b6a22e99524fb80a4a24128bebfb9970aefa16eb496792dbc7195 dataPath: - paths - /spacecrafts/{spacecraftId} - get possibleFixUrl: https://go.pstmn.io/openapi3-security-warnings#all-operations-should-have-summaries type: governance severity: ERROR vulnerability: name: All of your operations need summaries. slug: OPENAPI_SPECTRAL_6_operations_summary location: start: column: 8 line: 19 end: column: 50 line: 38 category: name: governance slug: governance message: All of your operations need summaries. schemaSecurityValidationSecurityWarnings: value: warnings: - dataPath: [] possibleFixUrl: https://go.pstmn.io/openapi3-security-warnings#security-field-is-not-defined type: security vulnerability: slug: OPENAPI_VUL_0003 name: Security field is not defined severity: ERROR category: slug: security name: security checksum: db2c5b351010e803bb3cebf21c48275909bd89715660fa1865e8c55595d4928d slug: OPENAPI_SCHEMA_RULE_0005 message: Security field is not defined location: end: line: 78 column: 21 start: line: 1 column: 0 - dataPath: - paths - /spacecrafts/{spacecraftId} - get possibleFixUrl: https://go.pstmn.io/openapi3-security-warnings#operation-does-not-enforce-any-security-scheme type: security vulnerability: slug: OPENAPI_VUL_0012 name: Operation does not enforce any security scheme severity: WARN category: slug: security name: security checksum: 44dd11f850da75d478d246361a95435c7dd8da799ce689a8648449af7b3c7b43 slug: OPENAPI_SCHEMA_RULE_0017 message: Operation does not enforce any security scheme. location: end: line: 39 column: 50 start: line: 19 column: 8 apiSecurity400ErrorInvalidSchema: value: error: name: name: Invalid Schema reason: Provided schema type is not supported. getTaggedEntities: value: data: entities: - entityId: 8b86dfe8-de72-44e6-81ea-79d19805bc6a entityType: collection meta: count: 1 getTaggedEntitiesWithNextCursor: value: data: entities: - entityId: 12345678-6fd634a3-79ba-451d-8f07-56a953f96667 entityType: collection - entityId: 7a95cfe8-de72-44e6-81ea-79d19805bd7b entityType: workspace meta: count: 2 nextCursor: eyJpZCI6ODYsImVudGl0eVR5cGUiOiJhcGkifQ== tagElement400Error: value: error: Bad Request message: params/slug must match pattern \"^[a-z][a-z0-9-]*[a-z0-9]+$\" statusCode: 400 getScimGroupResources: value: schemas: - urn:ietf:params:scim:api:messages:2.0:ListResponse totalResults: 2 startIndex: 1 itemsPerPage: 2 Resources: - schemas: - urn:ietf:params:scim:schemas:core:2.0:Group id: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00 displayName: TestAPI members: - value: 23a35c2723d34c03b4c56443c09e7173 display: Taylor Lee externalId: '1234' meta: resourceType: Group created: '2022-02-22T04:24:13.000Z' lastModified: '2022-02-22T04:24:13.000Z' - schemas: - urn:ietf:params:scim:schemas:core:2.0:Group id: 123775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 displayName: Test Group members: - value: 23a35c2723d34c03b4c56443c09e7173 display: Taylor Lee - value: b1c794f24f4c49f4b5d503a4cb2686ea display: Alex Cruz externalId: '4321' meta: resourceType: Group created: '2022-02-22T04:24:13.000Z' lastModified: '2022-02-22T04:24:13.000Z' scim400ErrorInvalidFilter: value: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: You've used filter(s) that Postman doesn't support. status: '400' scim401Error: value: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: Unable to access the team. Check if you have entered a valid API key. status: '401' scim403Error: value: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: Your API key was generated by a Team Admin who is no longer on your team. Use an API key generated by a Team Admin. status: '403' scim403ErrorAdminActionNotAllowed: value: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: The admin is not allowed to perform this action. status: '403' scim403ErrorUserNotInTeam: value: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: This person isn't a member of the team. status: '403' scimGroup500Error: value: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: Couldn't fetch members of the team. status: '500' createScimGroup: value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group displayName: TestAPI members: - value: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 displayName: Taylor Lee createScimGroupResponse: value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group id: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00 displayName: TestAPI externalId: '1234' members: - value: 23a35c2723d34c03b4c56443c09e7173 display: Taylor Lee meta: created: '2022-02-22T04:24:13.000Z' lastModified: '2022-02-22T04:24:13.000Z' resourceType: Group scim400ErrorInvalidSyntax: value: schemas: - urn:ietf:params:scim:api:messages:2.0:Error scimType: invalidSyntax detail: The request body seems to be incomplete or have unsupported characters. status: '400' scim400ErrorNotEnterprise: value: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: Only Postman teams on the Enterprise plan can use SCIM provisioning. Upgrade your plan. status: '400' scim400ErrorNoSlots: value: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: No slots available on your Postman team. Purchase or free up slots to invite more members. For help, contact Team Admins or members with a Billing role. status: '400' scim409Error: value: schemas: - urn:ietf:params:scim:api:messages:2.0:Error scimType: uniqueness detail: This person is already a member of the team. status: '409' scimUpdateGroup500Error: value: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: Couldn't update this team member's information. Try again — it should work next time around. status: '500' getScimGroupResource: value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group id: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 displayName: TestAPI members: - value: 23a35c2723d34c03b4c56443c09e7173 display: Taylor Lee externalId: '1234' meta: resourceType: Group created: '2022-02-22T04:24:13.000Z' lastModified: '2022-02-22T04:24:13.000Z' scim400Error: value: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: This Postman team doesn't exist anymore. status: '400' scimGroup404Error: value: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: This group isn't a member of the team. status: '404' scim500Error: value: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: Couldn't update this team member's information. Try again — it should work next time around. status: '500' scimUpdateGroup: value: schemas: - urn:ietf:params:scim:api:messages:2.0:PatchOp Operations: - op: replace value: id: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00 displayName: TestAPI scimUpdateGroupResponse: value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group id: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 displayName: TestAPI members: - value: 23a35c2723d34c03b4c56443c09e7173 display: Taylor Lee externalId: '1234' meta: resourceType: Group created: '2022-02-22T04:24:13.000Z' lastModified: '2022-02-22T04:24:13.000Z' getScimResourceTypes: value: - schemas: - urn:ietf:params:scim:schemas:core:2.0:ResourceType id: User name: User endpoint: /Users description: User Account schema: urn:ietf:params:scim:schemas:core:2.0:User schemaExtensions: - schema: urn:ietf:params:scim:schemas:extension:enterprise:2.0:User required: true - schemas: - urn:ietf:params:scim:schemas:core:2.0:ResourceType id: Group name: Group endpoint: /Groups description: Group schema: urn:ietf:params:scim:schemas:core:2.0:Group getScimServiceProviderConfig: value: schemas: - urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig documentationUri: https://learning.postman.com/docs/administration/managing-your-team/configuring-scim patch: supported: true bulk: supported: false maxOperations: 0 maxPayloadSize: 0 filter: supported: true maxResults: 100 changePassword: supported: false sort: supported: false etag: supported: false authenticationSchemes: - name: OAuth Bearer Token description: Authentication scheme using the OAuth Bearer Token Standard specUri: http://www.rfc-editor.org/info/rfc6750 type: oauthbearertoken meta: resourceType: ServiceProviderConfig location: https://api.postman.com/scim/v2/ServiceProviderConfig getScimUserResources: value: schemas: - urn:ietf:params:scim:api:messages:2.0:ListResponse totalResults: 2 startIndex: 1 itemsPerPage: 2 Resources: - schemas: - urn:ietf:params:scim:schemas:core:2.0:User id: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 userName: taylor.lee@example.com name: givenName: Taylor familyName: Lee externalId: '12345678' active: true meta: resourceType: User created: '2021-02-22T04:24:13.000Z' lastModified: '2021-02-22T04:24:13.000Z' - schemas: - urn:ietf:params:scim:schemas:core:2.0:User id: 123775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 userName: alex.cruz@example.com name: givenName: Alex familyName: Cruz externalId: '87654321' active: false meta: resourceType: User created: '2021-02-22T04:24:13.000Z' lastModified: '2021-02-22T04:24:13.000Z' getInactiveScimUserResources: value: schemas: - urn:ietf:params:scim:api:messages:2.0:ListResponse totalResults: 1 startIndex: 1 itemsPerPage: 2 Resources: - schemas: - urn:ietf:params:scim:schemas:core:2.0:User id: 123775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 userName: alex.cruz@example.com name: givenName: Alex familyName: Cruz externalId: '87654321' active: false meta: resourceType: User created: '2021-02-22T04:24:13.000Z' lastModified: '2021-02-22T04:24:13.000Z' createScimUser: value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User userName: taylor.lee@example.com name: givenName: Taylor familyName: Lee externalId: '12345678' displayName: Taylor Lee locale: en-US groups: - Test Group active: true createScimUserResponse: value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User id: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 userName: taylor-lee@example.com name: givenName: Test familyName: User emails: - primary: true value: taylor-lee@example.com type: work display: taylor-lee@example.com externalId: '12345678' active: true meta: resourceType: User created: '2021-02-22T04:24:13.000Z' lastModified: '2021-02-22T04:24:13.000Z' scimUserResourceResponse: value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User id: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 userName: taylor.lee@example.com name: givenName: Taylor familyName: Lee externalId: '12345678' active: true meta: resourceType: User created: '2021-02-22T04:24:13.000Z' lastModified: '2021-02-22T04:24:13.000Z' scim404Error: value: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: This person isn't a member of the team. status: '404' scim500ErrorUser: value: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: Unable to fetch information about this team member. status: '500' updateScimUser: value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User name: givenName: Taylor familyName: Lee updateScimUserEmail: value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User userName: taylor.lee@example.com active: true scimUserDomainInvalidEmail400Error: value: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: Unable to update the username for this user. - Please provide a valid email status: '400' scimUserDomainUnverified400Error: value: schemas: - urn:ietf:params:scim:api:messages:2.0:Error detail: Unable to update the username for this user. - Domain is not verified status: '400' updateScimUserPatch: value: schemas: - urn:ietf:params:scim:api:messages:2.0:PatchOp Operations: - op: replace value: active: true updateScimUserPatchEmail: value: schemas: - urn:ietf:params:scim:api:messages:2.0:PatchOp Operations: - op: replace path: userName value: taylor.lee@example.com sdkList: value: data: - id: 5b1c8e4a-9d10-4f7a-91d0-2c2f3a4b5c6d language: typescript source: type: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 workspaceId: 7f6c5d4e-3b2a-1234-9876-abcdef012345 version: 1.0.0 buildStatus: succeeded createdAt: '2026-06-02T14:11:09Z' updatedAt: '2026-06-02T14:12:55Z' meta: nextCursor: null total: 1 sdkListFailed: value: data: - id: 7e3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c language: python source: type: spec id: 9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d workspaceId: 7f6c5d4e-3b2a-1234-9876-abcdef012345 buildStatus: failed error: code: spec_validation_failed message: 'OpenAPI spec failed validation: missing operationId on GET /foo' createdAt: '2026-06-02T14:11:09Z' updatedAt: '2026-06-02T14:11:42Z' meta: nextCursor: null total: 1 sdkListByLanguage: value: data: - id: 8f4b2c3d-5e6f-7a8b-9c0d-1e2f3a4b5c6d language: go source: type: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 workspaceId: 7f6c5d4e-3b2a-1234-9876-abcdef012345 buildStatus: in_progress createdAt: '2026-06-02T15:02:00Z' updatedAt: '2026-06-02T15:02:05Z' meta: nextCursor: null total: 1 sdkListBatchPoll: value: data: - id: 5b1c8e4a-9d10-4f7a-91d0-2c2f3a4b5c6d language: typescript source: type: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 workspaceId: 7f6c5d4e-3b2a-1234-9876-abcdef012345 version: 1.0.0 buildStatus: succeeded createdAt: '2026-06-02T14:11:09Z' updatedAt: '2026-06-02T14:12:55Z' - id: 6c2d9f5b-ae21-5089-a2e1-3d3f4b5c6d7e language: java source: type: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 workspaceId: 7f6c5d4e-3b2a-1234-9876-abcdef012345 buildStatus: queued createdAt: '2026-06-02T16:00:00Z' updatedAt: '2026-06-02T16:00:00Z' meta: nextCursor: null total: 2 sdk400ErrorInvalidListQuery: value: type: https://api.postman.com/problems/sdks/invalid-list-query title: Invalid list query status: 400 detail: '`cursor` is malformed or expired.' instance: /sdks requestId: 3a51a64f-1234-4ce5-9e2a-c7d2b9a0b8f5 createSdkTypescript: value: language: typescript source: type: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 authors: - name: engineering Engineering email: sdk@engineering.com retry: maxAttempts: 5 retryDelay: 200 httpCodesToRetry: - 429 - 503 typescriptOptions: npmOrg: '@engineering' npmName: engineering-sdk createSdkPython: value: language: python source: type: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 pythonOptions: pypiPackageName: engineering-sdk createSdkGo: value: language: go source: type: spec id: 9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d goOptions: goModuleName: github.com/engineering/engineering-sdk createSdkJava: value: language: java source: type: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 javaOptions: groupId: com.engineering artifactId: engineering-sdk createSdkCsharp: value: language: csharp source: type: spec id: 9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d csharpOptions: packageId: engineering.Sdk createSdkRuby: value: language: ruby source: type: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 rubyOptions: gemName: engineering-sdk createSdkPhp: value: language: php source: type: spec id: 9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d phpOptions: packageName: engineering/sdk createSdkKotlin: value: language: kotlin source: type: spec id: 9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d kotlinOptions: groupId: com.engineering artifactId: engineering-sdk createSdkRust: value: language: rust source: type: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 rustOptions: packageName: engineering-sdk createSdkCli: value: language: cli source: type: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 cliOptions: goModuleName: github.com/engineering/engineering-cli sdk400ErrorInvalidCreateRequest: value: type: https://api.postman.com/problems/sdks/invalid-create-request title: Invalid SDK creation request status: 400 detail: '`language` must be one of: typescript, python, go, java, csharp, ruby, php, kotlin, rust, cli.' instance: /sdks requestId: 7f23c2c2-9c4f-4a5e-8a3b-d6d6f9f1b3a7 sdk422ErrorUnsupportedLanguageForSourceType: value: type: https://api.postman.com/problems/unprocessable-entity title: Unprocessable Entity status: 422 detail: The requested language is not supported for this source type. sdk: value: id: 5b1c8e4a-9d10-4f7a-91d0-2c2f3a4b5c6d language: typescript source: type: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 workspaceId: 7f6c5d4e-3b2a-1234-9876-abcdef012345 version: 1.0.0 buildStatus: succeeded createdAt: '2026-06-02T14:11:09Z' updatedAt: '2026-06-02T14:12:55Z' sdk409ErrorRequestConflict: value: type: https://api.postman.com/problems/conflict title: Conflict status: 409 detail: The request conflicts with the current state of the resource. sdkGitConnection409ErrorAlreadyConnected: value: type: https://api.postman.com/problems/sdk-git-connections/already-connected title: Git connection already exists status: 409 detail: A connection already exists for this source and typescript SDK. Use PUT to change it. instance: /sdk-git-connections requestId: 3d4e5f6a-7890-4bc1-9def-0123456789ab sdkDownload: value: id: 5b1c8e4a-9d10-4f7a-91d0-2c2f3a4b5c6d language: typescript url: https://sdk-gen-artifacts.s3.amazonaws.com/...signed... expiresAt: '2026-06-03T17:35:00Z' sdkGitConnectionList: value: data: - sdkGitConnectionId: 8d4f7c1a-2b3e-4f5a-9c8d-1a2b3c4d5e6f source: type: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 language: typescript status: active repositoryUrl: https://git.example.com/engineering/engineering-sdk targetBranch: main autoUpdatePullRequestsEnabled: true pullRequests: - url: https://git.example.com/engineering/engineering-sdk/pull/87 status: open sdkId: 9c4e7d1a-2b3c-4f5e-8a9b-1c2d3e4f5a6b createdAt: '2026-04-12T09:00:00Z' updatedAt: '2026-05-30T10:21:14Z' meta: nextCursor: null total: 1 sdkGitConnection400ErrorInvalidListQuery: value: type: https://api.postman.com/problems/sdk-git-connections/invalid-list-query title: Invalid git connection list query status: 400 detail: '`workspaceId` is required.' instance: /sdk-git-connections requestId: e1b2c3d4-5678-49ab-9012-3456789abcde sdkGitConnection400ErrorInvalidCreateRequest: value: type: https://api.postman.com/problems/sdk-git-connections/invalid-create-request title: Invalid git connection request status: 400 detail: Repository engineering/engineering-sdk is already connected to a python SDK. Each SDK language must use its own repository. instance: /sdk-git-connections requestId: 2c3d4e5f-6789-4ab0-9cde-0123456789ab sdkGitConnection400ErrorInvalidStatusTransition: value: type: https://api.postman.com/problems/sdk-git-connections/invalid-status-transition title: Invalid git connection status status: 400 detail: '`status` must be `active` or `disconnected`; `inaccessible` is system-determined and cannot be set.' instance: /sdk-git-connections/8d4f7c1a-2b3e-4f5a-9c8d-1a2b3c4d5e6f requestId: 0d6f7e8a-1234-49bc-9def-0123456789ab createSdkGitConnection: value: source: type: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 language: typescript repositoryUrl: https://git.example.com/engineering/engineering-sdk targetBranch: main autoUpdatePullRequestsEnabled: true createSdkGitConnectionManual: value: source: type: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 language: typescript repositoryUrl: https://git.example.com/engineering/engineering-sdk autoUpdatePullRequestsEnabled: false sdkGitConnection: value: sdkGitConnectionId: 8d4f7c1a-2b3e-4f5a-9c8d-1a2b3c4d5e6f source: type: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 language: typescript status: active repositoryUrl: https://git.example.com/engineering/engineering-sdk targetBranch: main autoUpdatePullRequestsEnabled: true pullRequests: - url: https://git.example.com/engineering/engineering-sdk/pull/87 status: open sdkId: 9c4e7d1a-2b3c-4f5e-8a9b-1c2d3e4f5a6b createdAt: '2026-04-12T09:00:00Z' updatedAt: '2026-05-30T10:21:14Z' updateSdkGitConnection: value: status: disconnected updateSdkGitConnectionAutoUpdate: value: status: active autoUpdatePullRequestsEnabled: true sdkGitConnectionPullRequestList: value: data: - number: 87 url: https://git.example.com/engineering/engineering-sdk/pull/87 status: merged sdk: id: 9c4e7d1a-2b3c-4f5e-8a9b-1c2d3e4f5a6b language: typescript source: type: collection id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 workspaceId: 7f6c5d4e-3b2a-1234-9876-abcdef012345 version: 1.0.4 buildStatus: succeeded createdAt: '2026-05-30T10:11:09Z' updatedAt: '2026-05-30T10:12:55Z' createdAt: '2026-05-30T10:15:00Z' updatedAt: '2026-05-30T10:21:14Z' meta: nextCursor: null total: 1 searchPostmanResourcesWorkspaces: value: q: test workspace elementType: workspaces ownership: organization filters: $and: - publisherIsVerified: $ne: true searchPostmanResourcesPublicWorkspaces: value: q: test elementType: requests ownership: organization filters: $and: - visibility: $eq: internal searchPostmanResourcesPublicWorkspacesVerifiedPublishers: value: q: testing elementType: requests ownership: all filters: $and: - visibility: $eq: public - publisherIsVerified: $eq: true searchPostmanResourcesPartnerWorkspaces: value: q: payment gateway elementType: requests ownership: external filters: $and: - visibility: $eq: partner searchPostmanResourcesPrivateApiNetwork: value: q: testing elementType: requests filters: $and: - privateNetwork: $eq: true searchPostmanResourcesExternalPublicApis: value: q: weather forecast elementType: requests ownership: external filters: $and: - visibility: $eq: public searchPostmanResourcesFlows: value: q: demo flow elementType: flows ownership: organization filters: $and: - visibility: $eq: internal searchPostmanResourcesInternalApisOrg: value: q: testing elementType: requests ownership: organization filters: $and: - visibility: $eq: internal searchPostmanResourcesRequestsNeFilter: value: q: Get all invoices elementType: requests filters: $and: - publisherIsVerified: $ne: false searchPostmanResourcesResponsePublicWorkspaces: value: data: - method: GET description: Retrieve all team members url: https://postman-echo.com/get?team=api-team name: Get Team Members id: 12345678-a1b2c3d4-e5f6-7890-abcd-ef1234567890 collection: id: 12345678-11223344-5566-7788-99aa-bbccddeeff00 name: API Team workspace: id: d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90 name: API Team Workspace links: web: href: https://go.postman.co/request/12345678-a1b2c3d4-e5f6-7890-abcd-ef1234567890 self: href: https://api.postman.com/collections/12345678-11223344-5566-7788-99aa-bbccddeeff00/requests/12345678-a1b2c3d4-e5f6-7890-abcd-ef1234567890 organization: id: '1' name: API Team Devs isVerified: false team: id: '123' name: API Team Devs createdBy: '12345678' isGitConnected: false - method: POST description: Create workspace url: https://postman-echo.com/post name: Create Workspace id: 12345678-f0e1d2c3-b4a5-9687-7654-321fedcba098 collection: id: 12345678-aabbccdd-eeff-0011-2233-445566778899 name: Workspace Operations workspace: id: d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90 name: API Team Workspace links: web: href: https://go.postman.co/request/12345678-f0e1d2c3-b4a5-9687-7654-321fedcba098 self: href: https://api.postman.com/collections/12345678-aabbccdd-eeff-0011-2233-445566778899/requests/12345678-f0e1d2c3-b4a5-9687-7654-321fedcba098 organization: id: '1' name: API Team Devs isVerified: false team: id: '123' name: API Team Devs createdBy: '12345678' isGitConnected: false meta: q: team total: 2 nextCursor: eyJmcm9tIjoxMH0= searchPostmanResourcesNoResultsFound: value: data: [] meta: q: testing total: 0 searchPostman400ErrorMissingElementTypeProperty: value: type: https://api.postman.com/problems/bad-request title: Bad Request status: 400 detail: body must have required property 'elementType' searchPostman400ErrorInvalidOwnershipValue: value: type: https://api.postman.com/problems/bad-request title: Bad Request status: 400 detail: '/ownership must be equal to one of the allowed values: organization, external, all' searchPostman400ErrorInvalidOwnershipAndVisibilityCombination: value: type: https://api.postman.com/problems/bad-request title: Bad Request status: 400 detail: ownership=external cannot be combined with visibility=internal searchPostman400ErrorInvalidPrivateNetworkAndOwnershipCombination: value: type: https://api.postman.com/problems/bad-request title: Bad Request status: 400 detail: privateNetwork=true can only be used with ownership=organization getAllSpecs: value: specs: - type: OPENAPI:3.0 createdAt: '2026-02-06T16:23:48.000Z' name: OpenAPI 3.0 (Files) updatedAt: '2026-02-06T16:24:51.000Z' id: 4e032b57-1fd6-41d7-882a-de5ac2107671 createdBy: 12345678 updatedBy: 12345678 - type: OPENAPI:3.0 createdAt: '2026-02-06T16:23:21.000Z' name: OpenAPI 3.0 updatedAt: '2026-02-06T16:23:25.000Z' id: c693c62f-f9dc-4f9d-ae9d-70ef7ee5dc13 createdBy: 87654321 updatedBy: 87654321 - type: OPENAPI:2.0 createdAt: '2026-02-06T16:23:08.000Z' name: OpenAPI 2.0 updatedAt: '2026-02-06T16:23:14.000Z' id: c35e472d-9d08-42c2-bf29-bb57d10ead31 createdBy: 56781234 updatedBy: 12345678 - type: OPENAPI:3.1 createdAt: '2026-02-06T16:21:33.000Z' name: OpenAPI 3.1 updatedAt: '2026-02-06T16:22:13.000Z' id: 05bcee59-b7b6-4d2b-9910-3a3291948fce createdBy: 87654321 updatedBy: 56781234 - type: ASYNCAPI:2.0 createdAt: '2026-02-06T16:20:40.000Z' name: Async API YAML updatedAt: '2026-02-06T16:20:46.000Z' id: c74e92cd-924d-4cca-b2c2-dc6fdd6da700 createdBy: 12345678 updatedBy: 12345678 - type: PROTOBUF:2 createdAt: '2026-02-06T15:46:08.000Z' name: Protobuf 2 (Files) updatedAt: '2026-02-06T15:46:15.000Z' id: a3c06b93-e6f2-466c-8197-340a2f8e2063 createdBy: 12345678 updatedBy: 12345678 - type: PROTOBUF:3 createdAt: '2026-02-06T15:45:49.000Z' name: Protobuf 3 updatedAt: '2026-02-06T15:45:53.000Z' id: 8ea532f9-cb6e-4306-b50d-3771c0926e31 createdBy: 12345678 updatedBy: 12345678 - type: PROTOBUF:2 createdAt: '2026-02-06T15:45:43.000Z' name: Protobuf 2 updatedAt: '2026-02-06T15:45:46.000Z' id: 2448ebdb-59c5-4287-80b3-78ef77234275 createdBy: 87654321 updatedBy: 87654321 - type: GRAPHQL createdAt: '2026-02-06T15:45:34.000Z' name: GraphQL updatedAt: '2026-02-06T15:45:39.000Z' id: 6184347c-8382-41cb-a3d2-af44336a69bb createdBy: 12345678 updatedBy: 12345678 - type: ASYNCAPI:2.0 createdAt: '2025-11-03T14:26:56.000Z' name: Async API JSON updatedAt: '2026-02-06T16:19:46.000Z' id: 482f7385-d937-4e0f-9e1f-bd812acc41fd createdBy: 12345678 updatedBy: 12345678 - type: ASYNCAPI:3.0 createdAt: '2026-05-19T13:27:02.337Z' name: Async API YAML updatedAt: '2026-05-19T13:27:02.337Z' id: 482f7385-d937-4e0f-9e1f-bd812acc41fd createdBy: 12345678 updatedBy: 12345678 - type: SMITHY:2.0 createdAt: '2026-05-06T13:59:38.000Z' name: Smithy updatedAt: '2026-05-06T13:59:38.000Z' id: 4e4b7c59-7851-40cb-8503-bbcabe5c7d0f createdBy: 12345678 updatedBy: 12345678 meta: nextCursor: null apiSpec400ErrorInvalidTaskId: value: type: notFoundError title: Instance not found status: 400 detail: Entity that you are trying to access does not exist. apiSpecFile400ErrorFileSizeExceeded: value: type: https://api.postman.com/problems/bad-request title: Malformed request status: 400 detail: File size exceeded the limit of 10 MB apiSpec400ErrorInvalidCollectionUid: value: type: invalidParamsError title: The specified parameter is in an invalid format status: 400 detail: Parameter, collectionUid is in an invalid format. apiSpec400ErrorInvalidParamError: value: type: invalidParamError title: Invalid request body detail: 'Missing parameter: ''name''' status: 400 apiSpec400ErrorFilesInvalidTypeParam: value: type: InvalidParamsError title: Required parameter is invalid status: 400 detail: 'Required property `type` is invalid. Should be one of: OPENAPI:3.0, ASYNCAPI:2.0' apiSpec400ErrorMalformedRequest: value: type: https://api.postman.com/problems/bad-request title: Malformed request status: 400 detail: The spec you are trying to fetch has errors, the definition for the same can't be generated apiSpec400ErrorMalformedSpecification: value: type: MalformedSpecification title: Malformed Specification. status: 400 detail: The spec you are trying to fetch has errors, the definition for the same can't be generated apiSpec400ErrorFilesInvalidMissingContentParam: value: type: invalidParamError title: Invalid request body status: 400 detail: The body parameter content is missing from the request. apiSpec400ErrorFilesInvalidMissingFilesParam: value: type: https://api.postman.com/problems/bad-request title: Malformed request status: 400 detail: Required body parameter files is missing apiSpec400ErrorMissingNameProperty: value: type: https://api.postman.com/problems/bad-request title: Malformed request status: 400 detail: Required property `name` is missing from the request. apiSpecFile400ErrorMissingRootFile: value: title: Malformed request type: https://api.postman.com/problems/bad-request status: 400 detail: At least one file must have type ROOT apiSpecFile400ErrorMultipleRootFiles: value: title: Malformed request type: https://api.postman.com/problems/bad-request status: 400 detail: Only one file can have type ROOT apiSpec400ErrorWorkspaceNotFound: value: type: https://api.postman.com/problems/bad-request title: Malformed request status: 400 detail: We could not find the workspace you are looking for. createSpecJson: value: name: Sample API type: OPENAPI:3.0 files: - path: index.json content: |- { "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Sample API", "description": "Buy or rent spacecrafts" }, "paths": { "/spacecrafts/{spacecraftId}": { "parameters": [ { "name": "spacecraftId", "description": "The unique identifier of the spacecraft", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SpacecraftId" } } ], "get": { "summary": "Read a spacecraft", "responses": { "200": { "description": "The spacecraft corresponding to the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Spacecraft" } } } }, "404": { "description": "No spacecraft found for the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "#/components/schemas/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key" } } }, "security": [ { "ApiKey": [ ] } ] } createSpecYaml: value: name: Sample API type: OPENAPI:3.0 files: - path: index.yaml content: | openapi: "3.0.0" info: version: "1.0.0" title: "Sample API" description: Buy or rent spacecrafts paths: /spacecrafts/{spacecraftId}: parameters: - name: spacecraftId description: The unique identifier of the spacecraft in: path required: true schema: $ref: "#/components/schemas/SpacecraftId" get: summary: Read a spacecraft responses: "200": description: The spacecraft corresponding to the provided `spacecraftId` content: application/json: schema: $ref: "#/components/schemas/Spacecraft" 404: description: No spacecraft found for the provided `spacecraftId` content: application/json: schema: $ref: "#/components/schemas/Error" 500: description: Unexpected error content: application/json: schema: $ref: "#/components/schemas/Error" components: schemas: SpacecraftId: description: The unique identifier of a spacecraft type: string Spacecraft: type: object required: - id - name - type properties: id: $ref: "#/components/schemas/SpacecraftId" name: type: string type: type: string enum: - capsule - probe - satellite - spaceplane - station description: type: string Error: type: object required: - message properties: message: description: A human readable error message type: string securitySchemes: ApiKey: type: apiKey in: header name: X-Api-Key security: - ApiKey: [] createSpecAsync2Json: value: name: Streetlights API type: ASYNCAPI:2.0 files: - path: index.json content: |- { "asyncapi": "2.5.0", "info": { "title": "Streetlights API", "version": "1.0.0", "description": "The Smartylighting Streetlights API allows you\nto remotely manage the city lights.\n", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "contact": { "name": "Streetlights API Developers", "url": "https://example.com/contact", "email": "contact@example.com" }, "termsOfService": "https://www.apache.org/licenses/LICENSE-2.0" }, "servers": { "mosquitto": { "url": "mqtt://test.mosquitto.org", "protocol": "mqtt" } }, "channels": { "light/measured": { "publish": { "summary": "Inform about environmental lighting conditions for a particular streetlight", "operationId": "onLightMeasured", "message": { "name": "LightMeasured", "payload": { "$ref": "#/components/schemas/LightMeasuredPayloadSchema" }, "examples": [ { "payload": { "id": 1, "lumens": 1, "sentAt": "2023-09-01T18:00:00.000Z" } } ] } } } }, "components": { "schemas": { "LightMeasuredPayloadSchema": { "type": "object", "description": "Payload for LightMeasured API", "required": [ "id", "lumens", "sentAt" ], "properties": { "id": { "type": "integer", "minimum": 0, "description": "Id of the streetlight" }, "lumens": { "type": "integer", "minimum": 0, "description": "Light intensity measured in lumens" }, "sentAt": { "type": "string", "format": "date-time", "description": "Date and time when the message was sent", "minLength": 20, "maxLength": 29 } } } } } } createSpecAsync2Yaml: value: name: Streetlights API type: ASYNCAPI:2.0 files: - path: index.yaml content: |- asyncapi: '2.5.0' info: title: Streetlights API version: '1.0.0' description: | The Smartylighting Streetlights API allows you to remotely manage the city lights. license: name: Apache 2.0 url: 'https://www.apache.org/licenses/LICENSE-2.0' contact: name: Streetlights API Developers url: https://example.com/contact email: contact@example.com termsOfService: https://www.apache.org/licenses/LICENSE-2.0 servers: mosquitto: url: mqtt://test.mosquitto.org protocol: mqtt channels: light/measured: publish: summary: Inform about environmental lighting conditions for a particular streetlight operationId: onLightMeasured message: name: LightMeasured payload: $ref: '#/components/schemas/LightMeasuredPayloadSchema' examples: - payload: id: 1 lumens: 1 sentAt: 2023-09-01T18:00:00Z components: schemas: LightMeasuredPayloadSchema: type: object description: Payload for LightMeasured API required: - id - lumens - sentAt properties: id: type: integer minimum: 0 description: Id of the streetlight lumens: type: integer minimum: 0 description: Light intensity measured in lumens sentAt: type: string format: date-time description: Date and time when the message was sent minLength: 20 maxLength: 29 createSpecAsync3Json: value: name: Streetlights API type: ASYNCAPI:3.0 files: - path: index.json content: |- { "asyncapi": "3.0.0", "info": { "title": "Streetlights API", "version": "1.0.0", "description": "The Smartylighting Streetlights API allows you\nto remotely manage the city lights.\n", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "contact": { "name": "Streetlights API Developers", "url": "https://example.com/contact", "email": "contact@example.com" }, "termsOfService": "https://www.apache.org/licenses/LICENSE-2.0" }, "servers": { "mosquitto": { "host": "test.mosquitto.org", "protocol": "mqtt" } }, "channels": { "lightMeasured": { "address": "light/measured", "messages": { "lightMeasured": { "$ref": "#/components/messages/LightMeasured" } } } }, "operations": { "onLightMeasured": { "action": "receive", "channel": { "$ref": "#/channels/lightMeasured" }, "summary": "Inform about environmental lighting conditions for a particular streetlight" } }, "components": { "messages": { "LightMeasured": { "name": "LightMeasured", "payload": { "$ref": "#/components/schemas/LightMeasuredPayload" } } }, "schemas": { "LightMeasuredPayload": { "type": "object", "description": "Payload for LightMeasured API", "required": [ "id", "lumens", "sentAt" ], "properties": { "id": { "type": "integer", "minimum": 0, "description": "Id of the streetlight" }, "lumens": { "type": "integer", "minimum": 0, "description": "Light intensity measured in lumens" }, "sentAt": { "type": "string", "format": "date-time", "description": "Date and time when the message was sent", "minLength": 20, "maxLength": 29 } } } } } } createSpecAsync3Yaml: value: name: Streetlights API type: ASYNCAPI:3.0 files: - path: index.yaml content: |- asyncapi: '3.0.0' info: title: Streetlights API version: '1.0.0' description: | The Smartylighting Streetlights API allows you to remotely manage the city lights. license: name: Apache 2.0 url: 'https://www.apache.org/licenses/LICENSE-2.0' contact: name: Streetlights API Developers url: https://example.com/contact email: contact@example.com termsOfService: https://www.apache.org/licenses/LICENSE-2.0 servers: mosquitto: host: test.mosquitto.org protocol: mqtt channels: lightMeasured: address: light/measured messages: lightMeasured: $ref: '#/components/messages/LightMeasured' operations: onLightMeasured: action: receive channel: $ref: '#/channels/lightMeasured' summary: Inform about environmental lighting conditions for a particular streetlight components: messages: LightMeasured: name: LightMeasured payload: $ref: '#/components/schemas/LightMeasuredPayload' schemas: LightMeasuredPayload: type: object description: Payload for LightMeasured API required: - id - lumens - sentAt properties: id: type: integer minimum: 0 description: Id of the streetlight lumens: type: integer minimum: 0 description: Light intensity measured in lumens sentAt: type: string format: date-time description: Date and time when the message was sent minLength: 20 maxLength: 29 createSpecGraphQL: value: name: Sample API type: GRAPHQL files: - path: index.graphql content: |- schema { query: Query mutation: Mutation } type User { id: String! name: String } type Query { user(id: String): User } type Mutation { addUser(name: String!): User! } createSpecProtobuf2: value: name: Sample API type: PROTOBUF:2 files: - path: index.proto content: |- syntax = "proto2"; package com.addressBook; message Person { required string name = 1; required int32 id = 2; optional string email = 3; } message AddressBook { repeated Person people = 1; } message AddressBookById { required int32 id = 1; } message AddressBookByName { required string name = 1; } service AddressBookService { rpc CreateAddressBook (AddressBook) returns (AddressBook) {} rpc GetAddressBook (AddressBookById) returns (AddressBook) {} rpc ListAddressBook (AddressBookByName) returns (stream AddressBook) {} } createSpecProtobuf3: value: name: Sample API type: PROTOBUF:3 files: - path: index.proto content: |- syntax = "proto3"; package com.book; message Book { int64 isbn = 1; string title = 2; string author = 3; } message GetBookRequest { int64 isbn = 1; } message GetBookViaAuthor { string author = 1; } service BookService { rpc GetBook (GetBookRequest) returns (Book) {} rpc GetBooksViaAuthor (GetBookViaAuthor) returns (stream Book) {} rpc GetGreatestBook (stream GetBookRequest) returns (Book) {} rpc GetBooks (stream GetBookRequest) returns (stream Book) {} } createSpecSmithy: value: name: Sample API type: SMITHY:2.0 files: - path: main.smithy content: | $version: "2" namespace com.example use aws.protocols#restJson1 /// A simple greeting service @restJson1 service GreetingService { version: "2024-01-01" operations: [GetGreeting, CreateGreeting] errors: [ValidationError] } /// Returns a greeting for the given name @http(method: "GET", uri: "/greeting/{name}", code: 200) @readonly operation GetGreeting { input := { /// The name to greet @required @httpLabel name: String } output := { /// The greeting message @required message: String } errors: [GreetingNotFoundError] } /// Creates a new greeting @http(method: "POST", uri: "/greeting", code: 201) operation CreateGreeting { input := { /// The name to greet @required name: String /// Optional custom message prefix prefix: String = "Hello" } output := { /// The created greeting message @required message: String } } /// Thrown when a greeting is not found @error("client") @httpError(404) structure GreetingNotFoundError { @required message: String } /// Thrown when the request input is invalid @error("client") @httpError(400) structure ValidationError { @required message: String /// Field-level validation errors fieldErrors: FieldErrorMap } map FieldErrorMap { key: String value: String } createMultiFileSpec: value: name: Sample API type: OPENAPI:3.0 files: - path: index.json type: ROOT content: |- { "openapi": "3.0.0", "servers": [ { "url": "example.com" } ], "info": { "contact": { "name": "Jon" }, "version": "1.0.0", "title": "Sample API", "description": "Buy or rent spacecrafts" }, "paths": { "/spacecrafts/{spacecraftId}": { "parameters": [ { "name": "spacecraftId", "description": "The unique identifier of the spacecraft", "in": "path", "required": true, "schema": { "$ref": "schemas.json#/SpacecraftId" } } ], "get": { "summary": "Read a spacecraft", "description": "Get information about a spacecraft.", "operationId": "getSpacecraft", "tags": [ "Spacecrafts" ], "responses": { "200": { "description": "The spacecraft corresponding to the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "schemas.json#/Spacecraft" } } } }, "404": { "description": "No spacecraft found for the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "schemas.json#/Error" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "schemas.json#/Error" } } } } } } } }, "components": { "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "x-api-key" } } }, "tags": [ { "name": "Spacecrafts" } ], "security": [ { "ApiKey": [] } ] } - path: schemas.json type: DEFAULT content: |- { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "#/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } } createSpecResponse: value: name: Sample API type: OPENAPI:3.0 updatedAt: '2025-03-15T13:48:28.000Z' createdAt: '2025-03-15T13:48:28.000Z' createdBy: 12345678 updatedBy: 12345678 id: b4fc1bdc-6587-4f9b-95c9-f768146089b4 getSpec: value: id: 73e15000-bc7a-4802-b80e-05fff18fd7f8 name: Sample API type: OPENAPI:3.0 fileFormat: yaml createdBy: 12345678 updatedBy: 12345678 createdAt: '2025-03-15T13:48:28.000Z' updatedAt: '2025-03-15T13:48:28.000Z' updateSpecPropertiesRename: value: name: Sample API updateSpecPropertiesResponse: value: id: ae2b9ab2-28f2-401d-912f-eca09a78e98b type: OPENAPI:3.0 createdBy: 12345678 updatedBy: 12345678 createdAt: '2025-03-15T13:48:28.000Z' updatedAt: '2025-03-15T13:48:28.000Z' name: Sample API updateSpecSyncOptions: value: syncOptions: syncExamples: true deleteOrphanedRequests: true updateSpecSyncOptionsResponse: value: syncOptions: syncExamples: true deleteOrphanedRequests: true apiSpecSyncOptions400ErrorMalformedRequest: value: title: Malformed request type: https://api.postman.com/problems/bad-request status: 400 detail: syncOptions should be there in the request body. apiSpecSyncOptions401Error: value: type: https://api.postman.com/problems/unauthorized title: Unauthorized status: 401 detail: Unauthorized instance: /specifications/73e15000-bc7a-4802-b80e-05fff18fd7f8/collections/12ece9e1-2abf-4edc-8e34-de66e74114d2 getSpecDefinitionJson: value: |- { "openapi": "3.0.0", "servers": [ { "url": "example.com" } ], "info": { "contact": { "name": "" }, "version": "1.0.0", "title": "Sample API", "description": "Buy or rent spacecrafts" }, "paths": { "/spacecrafts/{spacecraftId}": { "parameters": [ { "name": "spacecraftId", "description": "The unique identifier of the spacecraft", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SpacecraftId" } } ], "get": { "summary": "Read a spacecraft", "responses": { "200": { "description": "The spacecraft corresponding to the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Spacecraft" } } } }, "404": { "description": "No spacecraft found for the provided `spacecraftId`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "A short summary of what the operation does.", "responses": { "200": { "description": "A short description of the response.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/pathName": { "summary": "A short summary intended to apply to all operations in this path.", "get": { "summary": "A short summary of what the operation does.", "responses": { "200": { "description": "A short description of the response.", "content": { "application/json": { "schema": { "type": "string" } } } } } } } }, "components": { "schemas": { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "#/components/schemas/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key" } } }, "security": [ { "ApiKey": [] } ] } getSpecDefinitionYaml: value: | openapi: "3.0.0" servers: - url: example.com info: contact: name: Jon version: "1.0.0" title: "Sample API" description: Buy or rent spacecrafts paths: /spacecrafts/{spacecraftId}: parameters: - name: spacecraftId description: The unique identifier of the spacecraft in: path required: true schema: description: The unique identifier of a spacecraft type: string get: summary: Read a spacecraft responses: "200": description: The spacecraft corresponding to the provided `spacecraftId` content: application/json: schema: type: object required: - id - name - type properties: id: description: The unique identifier of a spacecraft type: string name: type: string type: type: string enum: - capsule - probe - satellite - spaceplane - station description: type: string "404": description: No spacecraft found for the provided `spacecraftId` content: application/json: schema: type: object required: - message properties: message: description: A human readable error message type: string "500": description: Unexpected error content: application/json: schema: type: object required: - message properties: message: description: A human readable error message type: string components: securitySchemes: ApiKey: type: apiKey in: header name: X-Api-Key security: - ApiKey: [] getSpecFiles: value: files: - updatedBy: 12345678 updatedAt: '2025-07-22T18:48:39.000Z' path: components/parameters/spacecrafts.json createdAt: '2025-07-22T18:46:25.000Z' type: DEFAULT createdBy: 12345678 name: spacecrafts.json id: 7224f35c-d4d4-4e6e-8d73-21255ba87c0a - updatedBy: 12345678 updatedAt: '2025-07-22T18:48:12.000Z' path: components/responses/spacecrafts.json createdAt: '2025-07-22T18:46:18.000Z' type: DEFAULT createdBy: 12345678 name: spacecrafts.json id: 2e83adf5-5a2a-412f-b81a-3d83b1705681 - updatedBy: 12345678 updatedAt: '2025-07-22T18:47:03.000Z' path: components/schemas/spacecrafts.json createdAt: '2025-07-22T18:45:48.000Z' type: DEFAULT createdBy: 12345678 name: spacecrafts.json id: edc9f9f1-c0df-4a9a-9b5b-d4c7359d92ab - path: index.json updatedAt: '2025-07-22T18:47:32.000Z' name: index.json createdAt: '2025-07-22T18:42:18.000Z' type: ROOT createdBy: 12345678 updatedBy: 12345678 id: 3860602b-7a92-45a6-8b60-725ff7b453d5 meta: nextCursor: VGh1IE1hciAxNiAyMDIzIDE3OjIxOjUzIEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk= createJsonSpecFile: value: path: schemas.json content: |- { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "#/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } } createYamlSpecFile: value: path: schemas.yaml content: | SpacecraftId: description: The unique identifier of a spacecraft type: string Spacecraft: type: object required: - id - name - type properties: id: "$ref": "#/SpacecraftId" name: type: string type: type: string enum: - capsule - probe - satellite - spaceplane - station description: type: string Error: type: object required: - message properties: message: description: A human readable error message type: string createProtobufSpecFile: value: path: file.proto content: | syntax = "proto3"; package com.book; message Book { int64 isbn = 1; string title = 2; string author = 3; } message GetBookRequest { int64 isbn = 1; } message GetBookViaAuthor { string author = 1; } service BookService { rpc GetBook (GetBookRequest) returns (Book) {} rpc GetBooksViaAuthor (GetBookViaAuthor) returns (stream Book) {} rpc GetGreatestBook (stream GetBookRequest) returns (Book) {} rpc GetBooks (stream GetBookRequest) returns (stream Book) {} } createNestedSpecFile: value: path: components/schemas/spacecrafts.json content: |- { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "../schemas/spacecrafts.json#/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } } createUpdateSpecFileResponseJson: value: createdAt: '2025-07-22T19:29:08.000Z' createdBy: 12345678 id: 2fdc8ea1-d02e-4e50-989e-6fa28f42b995 path: schemas.json updatedAt: '2025-07-22T19:29:57.000Z' updatedBy: 12345678 type: ROOT createUpdateSpecFileResponseYaml: value: createdAt: '2025-07-22T19:29:08.000Z' createdBy: 12345678 id: 2fdc8ea1-d02e-4e50-989e-6fa28f42b995 path: schemas.yaml updatedAt: '2025-07-22T19:29:57.000Z' updatedBy: 12345678 type: ROOT createUpdateSpecFileResponseProtobuf: value: createdAt: '2026-04-14T17:44:29.389Z' updatedBy: 12345678 createdBy: 12345678 path: file.proto updatedAt: '2026-04-14T17:44:29.389Z' type: DEFAULT id: 799c482f-ffe6-4399-a919-b3cf6a3da888 createUpdateSpecFileResponseNested: value: createdAt: '2025-07-22T19:29:08.000Z' createdBy: 12345678 id: e8a015e0-f472-4bb3-a523-57ce7c4583ed path: components/schemas/spacecrafts.json updatedAt: '2025-07-22T19:29:57.000Z' updatedBy: 12345678 type: DEFAULT apiSpecFile400ErrorInvalidPathValue: value: title: Malformed request type: https://api.postman.com/problems/bad-request status: 400 detail: The required body parameter is missing from the request. apiSpecFile400ErrorInvalidFilePath: value: type: https://api.postman.com/problems/bad-request title: Malformed request status: 400 detail: The path parameter /filePath is invalid. apiSpecFile400ErrorInvalidRequestBody: value: title: Malformed request type: https://api.postman.com/problems/bad-request status: 400 detail: Only one of 'content', 'type', or 'name' should be provided. apiSpecFile400ErrorInvalidFileExtension: value: type: https://api.postman.com/problems/bad-request title: Invalid parameters status: 400 detail: Invalid file extension getSpecFile: value: createdAt: '2025-07-22T19:29:08.000Z' content: |- { "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Sample API", "description": "Buy or rent spacecrafts", "contact": { "name": "Taylor Lee" } }, "servers": [ { "url": "https://example.com" } ], "security": [ { "ApiKey": [] } ], "paths": { "/spacecrafts/{spacecraftId}": { "parameters": [ { "$ref": "./components/parameters/spacecrafts.json#/SpacecraftId" } ], "get": { "summary": "Read a spacecraft", "description": "Gets information about a spacecraft.", "operationId": "getSpacecraft", "tags": [ "Spacecrafts" ], "responses": { "200": { "$ref": "./components/responses/spacecrafts.json#/SuccessfulResponse" }, "404": { "$ref": "./components/responses/spacecrafts.json#/NotFound" }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "./components/schemas/spacecrafts.json#/Error" } } } } } } } }, "tags": [ { "name": "Spacecrafts" } ], "components": { "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key" } } } } updatedAt: '2025-07-22T19:29:57.000Z' createdBy: 12345678 updatedBy: 12345678 id: 3860602b-7a92-45a6-8b60-725ff7b453d5 type: ROOT path: index.json name: index.json getSpecFileNested: value: createdAt: '2025-07-22T18:45:48.000Z' content: |- { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "../schemas/spacecrafts.json#/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } } updatedAt: '2025-07-22T18:47:03.000Z' createdBy: 12345678 updatedBy: 12345678 id: edc9f9f1-c0df-4a9a-9b5b-d4c7359d92ab type: DEFAULT path: components/schemas/spacecrafts.json name: spacecrafts.json updateJsonSpecFile: value: content: |- { "SpacecraftId": { "description": "The unique identifier of a spacecraft", "type": "string" }, "Spacecraft": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "$ref": "../schemas/spacecrafts.json#/SpacecraftId" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "capsule", "probe", "satellite", "spaceplane", "station" ] }, "description": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "description": "A human readable error message", "type": "string" } } } } updateYamlSpecFile: value: content: | SpacecraftId: description: The unique identifier of a spacecraft type: string Spacecraft: type: object required: - id - name - type properties: id: "$ref": "#/SpacecraftId" name: type: string type: type: string enum: - capsule - probe - satellite - spaceplane - station description: type: string Error: type: object required: - message properties: message: description: A human readable error message type: string updateProtobufSpecFile: value: content: | syntax = "proto3"; package com.book; message Book { int64 isbn = 1; string title = 2; string author = 3; } message GetBookRequest { int64 isbn = 1; } message GetBookViaAuthor { string author = 1; } service BookService { rpc GetBook (GetBookRequest) returns (Book) {} rpc GetBooksViaAuthor (GetBookViaAuthor) returns (stream Book) {} rpc GetGreatestBook (stream GetBookRequest) returns (Book) {} rpc GetBooks (stream GetBookRequest) returns (stream Book) {} } updateJsonSpecFileType: value: type: ROOT updateJsonSpecFileName: value: name: index.json updateJsonSpecFileInvalidBody: value: name: index.json type: ROOT getSpecCollections: value: meta: nextCursor: null collections: - id: e8a015e0-f472-4bb3-a523-57ce7c4583ed name: Sample API state: in-sync createdAt: '2025-03-17T11:03:15Z' updatedAt: '2025-03-17T11:03:15Z' createdBy: 12345678 - id: 876211d4-fff8-439c-bb3f-ffb3c565dd21 name: Sample API state: out-of-sync createdAt: '2025-03-15T11:37:15Z' updatedAt: '2025-03-15T11:37:15Z' createdBy: 12345678 generateCollection: value: name: Sample API options: enableOptionalParameters: true folderStrategy: Tags getSpecVersionTagFile: value: data: - path: index.yaml content: | swagger: '2.0' info: title: 'REST API basics: CRUD, test & variable' description: >- # 🚀 Get started here This template guides you through CRUD operations (GET, POST, PUT, DELETE), variables, and tests. ## 🔖 **How to use this template** #### **Step 1: Send requests** RESTful APIs allow you to perform CRUD operations using the POST, GET, PUT, and DELETE HTTP methods. This collection contains each of these [request](https://learning.postman.com/docs/sending-requests/requests/) types. Open each request and click "Send" to see what happens. #### **Step 2: View responses** Observe the response tab for status code (200 OK), response time, and size. #### **Step 3: Send new Body data** Update or add new data in "Body" in the POST request. Typically, Body data is also used in PUT request. ``` { "name": "Add your name in the body" } ``` #### **Step 4: Update the variable** Variables enable you to store and reuse values in Postman. We have created a [variable](https://learning.postman.com/docs/sending-requests/variables/) called `base_url` with the sample request [https://postman-api-learner.glitch.me](https://postman-api-learner.glitch.me). Replace it with your API endpoint to customize this collection. #### **Step 5: Add tests in the "Scripts" tab** Adding tests to your requests can help you confirm that your API is working as expected. You can write test scripts in JavaScript and view the output in the "Test Results" tab. ## 💪 Pro tips - Use folders to group related requests and organize the collection. - Add more [scripts](https://learning.postman.com/docs/writing-scripts/intro-to-scripts/) to verify if the API works as expected and execute workflows. ## 💡Related templates [API testing basics](https://go.postman.co/redirect/workspace?type=personal&collectionTemplateId=e9a37a28-055b-49cd-8c7e-97494a21eb54&sourceTemplateId=ddb19591-3097-41cf-82af-c84273e56719) [API documentation](https://go.postman.co/redirect/workspace?type=personal&collectionTemplateId=e9c28f47-1253-44af-a2f3-20dce4da1f18&sourceTemplateId=ddb19591-3097-41cf-82af-c84273e56719) [Authorization methods](https://go.postman.co/redirect/workspace?type=personal&collectionTemplateId=31a9a6ed-4cdf-4ced-984c-d12c9aec1c27&sourceTemplateId=ddb19591-3097-41cf-82af-c84273e56719) version: 1.0.0 paths: /info: get: summary: Get data description: >- This is a GET request and it is used to "get" data from an endpoint. There is no request body for a GET request, but you can use query parameters to help specify the resource you want data on (e.g., in this request, we have `id=1`). A successful GET response will have a `200 OK` status, and should include some kind of response body - for example, HTML web content or JSON data. consumes: - application/json parameters: - name: id in: query type: integer responses: {} post: summary: Post data description: >- This is a POST request, submitting data to an API via the request body. This request submits JSON data, and the data is reflected in the response. A successful POST request typically returns a `200 OK` or `201 Created` response code. consumes: - application/json parameters: - name: body in: body schema: type: object properties: name: type: string responses: {} put: summary: Update data description: >- This is a PUT request and it is used to overwrite an existing piece of data. For instance, after you create an entity with a POST request, you may want to modify that later. You can do that using a PUT request. You typically identify the entity being updated by including an identifier in the URL (eg. `id=1`). A successful PUT request typically returns a `200 OK`, `201 Created`, or `204 No Content` response code. consumes: - application/json parameters: - name: id in: query type: integer - name: body in: body schema: type: object properties: name: type: string responses: {} delete: summary: Delete data description: >- This is a DELETE request, and it is used to delete data that was previously created via a POST request. You typically identify the entity being updated by including an identifier in the URL (eg. `id=1`). A successful DELETE request typically returns a `200 OK`, `202 Accepted`, or `204 No Content` response code. consumes: - application/json parameters: - name: id in: query type: integer - name: body in: body schema: type: object responses: {} host: template.postman-echo.com schemes: - https fileType: ROOT updatedAt: '2026-04-29T19:38:29.000Z' id: 158bd551-4e3d-4397-a27f-4034ac33f1f6 createdAt: '2026-03-10T17:05:11.000Z' createdBy: '12345678' updatedBy: '12345678' type: FILE name: index.yaml getSpecVersionTagMultiFile: value: data: - id: 6993ec3e-677b-4586-8856-169cc95030a2 name: components updatedBy: '12345678' createdAt: '2025-07-08T19:32:48.000Z' updatedAt: '2025-07-08T19:32:49.000Z' createdBy: '12345678' type: FOLDER path: components - createdBy: '12345678' updatedBy: '12345678' createdAt: '2025-07-08T19:33:02.000Z' updatedAt: '2025-07-08T19:33:09.000Z' type: FOLDER id: aa2d66e5-079a-4786-8a85-72770fac5967 name: parameters parentId: 6993ec3e-677b-4586-8856-169cc95030a2 path: components/parameters - createdBy: '12345678' updatedBy: '12345678' createdAt: '2025-07-08T19:33:27.000Z' fileType: DEFAULT content: | SpacecraftId: name: spacecraftId description: The unique identifier of the spacecraft in: path required: true schema: $ref: ../schemas/spacecrafts.yaml#/SpacecraftId id: a2074528-e9fa-400d-b343-9deab40c02b8 name: spacecrafts.yaml parentId: aa2d66e5-079a-4786-8a85-72770fac5967 updatedAt: '2025-07-08T19:35:58.000Z' path: components/parameters/spacecrafts.yaml type: FILE - createdBy: '12345678' updatedBy: '12345678' createdAt: '2025-07-08T19:33:18.000Z' updatedAt: '2025-07-08T19:33:20.000Z' type: FOLDER id: 2647f42c-3307-414f-b949-9a9b07b4cbd9 name: responses parentId: 6993ec3e-677b-4586-8856-169cc95030a2 path: components/responses - createdBy: '12345678' updatedBy: '12345678' createdAt: '2025-07-08T19:33:39.000Z' fileType: DEFAULT content: |- SuccessfulResponse: description: The spacecraft corresponding to the provided `spacecraftId` content: application/json: schema: $ref: ../schemas/spacecrafts.yaml#/Spacecraft NotFound: description: No spacecraft found for the provided `spacecraftId` content: application/problem+json: schema: $ref: ../schemas/spacecrafts.yaml#/Error UnexpectedError: description: Unexpected error content: application/problem+json: schema: $ref: ../schemas/spacecrafts.yaml#/Error id: 7a65e696-76fe-462d-a374-b4de06cac805 name: spacecrafts.yaml parentId: 2647f42c-3307-414f-b949-9a9b07b4cbd9 updatedAt: '2025-07-08T20:03:33.000Z' path: components/responses/spacecrafts.yaml type: FILE - createdBy: '12345678' updatedBy: '12345678' createdAt: '2025-07-08T19:33:24.000Z' updatedAt: '2025-07-08T19:33:25.000Z' type: FOLDER id: 597e7c88-fd2d-482d-a667-e7881629eaa8 name: schemas parentId: 6993ec3e-677b-4586-8856-169cc95030a2 path: components/schemas - createdBy: '12345678' updatedBy: '12345678' createdAt: '2025-07-08T19:33:46.000Z' fileType: DEFAULT content: | SpacecraftId: description: The unique identifier of a spacecraft type: string Spacecraft: type: object required: - id - name - type properties: id: $ref: "#/SpacecraftId" name: type: string type: type: string enum: - capsule - probe - satellite - spaceplane - station description: type: string Error: type: object properties: type: type: string description: The type of error. example: https://api.postman.com/problems/forbidden title: type: string description: A short summary of the problem. example: You are not permitted to perform the action. status: type: integer description: The error's HTTP status code. example: 403 detail: type: string description: Information about the error. example: Please ensure that you have required permissions id: cfdb32f1-f028-446f-9da6-ddeaa2a53b48 name: spacecrafts.yaml parentId: 597e7c88-fd2d-482d-a667-e7881629eaa8 updatedAt: '2025-07-08T20:04:28.000Z' path: components/schemas/spacecrafts.yaml type: FILE - createdBy: '12345678' updatedBy: '12345678' createdAt: '2025-07-08T19:31:57.000Z' fileType: ROOT content: | openapi: '3.0.0' info: version: '1.0.0' title: Sample API description: Buy or rent spacecrafts contact: name: Taylor Lee servers: - url: https://example.com security: - ApiKey: [] paths: /spacecrafts/{spacecraftId}: parameters: - $ref: ./components/parameters/spacecrafts.yaml#/SpacecraftId get: summary: Read a spacecraft description: Gets information about a spacecraft. operationId: getSpacecraft tags: - Spacecrafts responses: '200': $ref: ./components/responses/spacecrafts.yaml#/SuccessfulResponse '404': $ref: ./components/responses/spacecrafts.yaml#/NotFound '500': $ref: ./components/responses/spacecrafts.yaml#/UnexpectedError tags: - name: Spacecrafts components: securitySchemes: ApiKey: type: apiKey in: header name: X-Api-Key id: 71c6f91f-5813-4800-a5fc-bea764b4a5d1 name: index.yaml updatedAt: '2026-04-29T20:07:11.000Z' path: index.yaml type: FILE getSpecVersionTags: value: meta: nextCursor: null data: - id: 5b7fa363-d6f6-40f6-8751-37987112cf14 name: 1.0.1 - id: 2cefdde6-f912-4cb4-86b1-c874d7d5ea03 name: 1.0.0 createSpecVersionTag: value: name: v1.0.0 createSpecVersionTagResponse: value: data: id: 9c3c45e4-183a-4bc4-92aa-6b39d047377d name: 1.0.0 apiSpec409ErrorVersionTagConflict: value: type: conflictError title: Conflict detail: A version tag already exists for the current changelog group. Make new changes to the spec to create a version tag. status: 409 getTeams: value: data: - createdAt: '2025-01-27T10:36:02.000Z' updatedAt: '2025-02-26T08:17:42.000Z' id: 123 name: Testing Team handle: testing-team description: API testing team. organizationId: 1 createdBy: 12345678 enabled: true memberCount: 6 - createdAt: '2025-01-27T10:36:02.000Z' updatedAt: '2025-02-26T08:17:42.000Z' id: 231 name: Billing Team handle: billing-team description: The Billing team. organizationId: 2 createdBy: 12345678 enabled: true memberCount: 2 metadata: nextCursor: NTczNDg= teams401ErrorTeamFeatureUnavailable: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: error: name: BadRequest message: Team feature is not available for your organization. instance: /teams teams400ErrorTeamNameAlreadyExists: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: error: name: InvalidParams message: This name is already taken in the organization. Please choose another. instance: /teams teams400ErrorTeamIdNotFound: value: type: https://api.postman.com/problems/not-found status: 404 title: Not Found detail: error: name: EntityNotFound message: No team found with the id provided instance: /teams/12345 teams400ErrorInvalidAction: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: Action must be either approve or deny instance: /teams/123/access-requests/1095 teams400ErrorTeamNameInvalid: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: error: name: InvalidParams message: Only alphanumeric characters and spaces are allowed in the name instance: /teams teams400ErrorEntitiesNotPartOfTeam: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: error: name: InvalidParams message: 'Entities are not part of team : users - 87514321,41674321, groups - 89654321' instance: /teams/57833/members teams400ErrorAddRemoveWithFailures: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: error: Found invalid entities result: - entityType: user entityId: 87654321 role: null status: Invalid reason: Existing and new roles are empty instance: /teams/123/members teams400ErrorTeamRequestInvalidRole: value: type: https://api.postman.com/problems/bad-request status: 400 title: Bad Request detail: error: Found invalid entities result: - entityType: team entityId: '123' role: TEAM_MANAGER status: Invalid reason: Members can only be users or usergroups instance: /teams/123/access-requests teams401ErrorUnauthorized: value: title: Unauthorized instance: /teams status: 401 type: https://api.postman.com/problems/unauthorized detail: Unauthorized teams500ErrorInternalServerError: value: type: https://api.postman.com/problems/internal-server-error status: 500 title: Internal Server Error detail: error: name: UnexpectedError message: There was an issue while finding Team. instance: /teams createTeam: value: name: Testing Team description: API testing team. createGetTeamResponse: value: team: createdAt: '2025-02-26T08:17:42.000Z' updatedAt: '2025-02-26T08:17:42.000Z' id: 123 name: Testing Team handle: testing-team description: API testing team. organizationId: 1 createdBy: 12345678 enabled: true teams403ErrorTeamNoAccessRequestPermissions: value: type: https://api.postman.com/problems/forbidden status: 403 title: Forbidden detail: error: name: NoPermission message: You are not allowed to manage pending requests in team. instance: /teams/123/access-requests teams403ErrorNoAccessRequestsManagementPermission: value: type: https://api.postman.com/problems/forbidden status: 403 title: Forbidden detail: error: name: NoPermission message: You are not allowed to manage pending requests in team. instance: /teams/123/access-requests/1096 teams403ErrorNoTeamCreatePermission: value: type: https://api.postman.com/problems/forbidden status: 403 title: Forbidden detail: error: name: NoPermission message: You are not allowed to create Team. instance: /teams teams403ErrorCannotRemoveTeamMembers: value: type: https://api.postman.com/problems/forbidden status: 403 title: Forbidden detail: error: name: NoPermission message: You are not allowed to remove Team members. instance: /teams/123/members getTeamAccessRequests: value: data: - createdAt: '2025-10-10T18:54:09.000Z' updatedAt: '2025-10-10T18:54:09.000Z' id: 1 role: TEAM_DEVELOPER requestType: REQUEST_TO_ADD_MEMBERS reason: Needs the developer role. status: Requested entityType: user entityId: 1317604 objectType: team objectId: 1 createdBy: 12345678 - createdAt: '2025-10-10T18:57:58.000Z' updatedAt: '2025-10-10T18:57:58.000Z' id: 2 role: TEAM_MANAGER requestType: UPGRADE_ROLE reason: I need the team manager role for my team. status: Requested entityType: user entityId: 12345678 objectType: team objectId: 2 createdBy: 12345678 metadata: nextCursor: null getTeamAccessRequestsScimId: value: data: - createdAt: '2025-10-10T18:54:09.000Z' updatedAt: '2025-10-10T18:54:09.000Z' id: 1 role: TEAM_DEVELOPER requestType: REQUEST_TO_ADD_MEMBERS reason: Needs the developer role. status: Requested entityType: user entityId: 937a3efba0d1e20642fabd0aa692b3ce30969fb92a0b0d6d objectType: team objectId: 1 createdBy: 33d8e85cc5ec04715bb0c18b42312d80413bad8a96622eb7 - createdAt: '2025-10-10T18:57:58.000Z' updatedAt: '2025-10-10T18:57:58.000Z' id: 2 role: TEAM_MANAGER requestType: UPGRADE_ROLE reason: I need the team manager role for my team. status: Requested entityType: user entityId: 696e7061fe5aa0e7abb54851cdb0e3b21eed4f8daef24d13 objectType: team objectId: 2 createdBy: 33d8e85cc5ec04715bb0c18b42312d80413bad8a96622eb7 metadata: nextCursor: null createAccessRequestUserRole: value: entityList: - entityType: user entityId: '12345678' role: TEAM_MANAGER reason: Needs the manager role. requestType: UPGRADE_ROLE createAccessRequestGuestRole: value: entityList: - entityType: user entityId: '87654321' role: TEAM_GUEST_VIEWER reason: '' requestType: REQUEST_TO_ADD_MEMBERS createAccessRequestGuestDevelopers: value: entityList: - entityType: user entityId: '87654321' - entityType: user entityId: '45678123' role: TEAM_GUEST_DEVELOPER reason: Joining for debugging. requestType: REQUEST_TO_ADD_MEMBERS createAccessRequestRoleUpgrade: value: entityList: - entityType: user entityId: '12345678' role: TEAM_MANAGER reason: I need the team manager role. requestType: UPGRADE_ROLE createAccessRequestGuestTeamViewer: value: entityList: - entityType: team entityId: '432' role: TEAM_GUEST_VIEWER reason: '' requestType: REQUEST_TO_ADD_MEMBERS createAccessRequestOrganization: value: entityList: - entityType: organization entityId: '456' role: TEAM_GUEST_VIEWER reason: '' requestType: REQUEST_TO_ADD_MEMBERS createAccessRequestOrganizationRoleUpgrade: value: entityList: - entityType: organization entityId: '456' role: TEAM_GUEST_DEVELOPER reason: '' requestType: UPGRADE_ROLE createAccessRequestUserRoleResponse: value: result: - entityType: user entityId: 12345678 role: TEAM_MANAGER status: Skipped reason: Entity has this role createAccessRequestGuestRoleResponse: value: result: - entityType: user entityId: 87654321 role: TEAM_GUEST_VIEWER previousRole: null status: Accepted createAccessRequestGuestDevelopersResponse: value: result: - entityType: user entityId: 87654321 role: TEAM_GUEST_DEVELOPER previousRole: null status: Accepted - entityType: user entityId: 45678123 role: TEAM_GUEST_DEVELOPER previousRole: null status: Accepted createAccessRequestRoleUpgradeResponse: value: result: - entityType: user entityId: 12345678 role: TEAM_MANAGER previousRole: TEAM_DEVELOPER status: Accepted createAccessRequestGuestTeamViewerResponse: value: result: - entityType: team entityId: 432 role: TEAM_GUEST_VIEWER previousRole: null status: Accepted createAccessRequestAddOrganizationResponse: value: result: - entityType: organization entityId: 456 role: TEAM_GUEST_VIEWER previousRole: null status: Accepted createAccessRequestOrganizationRoleUpgradeResponse: value: result: - entityType: organization entityId: 456 role: TEAM_GUEST_DEVELOPER previousRole: TEAM_GUEST_VIEWER status: Accepted createAccessRequestAcceptedWithExistingRequestsResponse: value: result: - entityType: user entityId: 432 role: TEAM_DEVELOPER previousRole: null status: Skipped reason: RFA already exists for this entity - entityType: user entityId: 124 role: TEAM_DEVELOPER previousRole: null status: Accepted - entityType: group entityId: 1234 role: TEAM_DEVELOPER previousRole: null status: Accepted createAccessRequestUserHasRoleResponse: value: result: - entityType: team entityId: 432 role: TEAM_GUEST_DEVELOPER status: Skipped reason: Entity has this role approveDenyAccessRequest: value: action: approve approveDenyAccessRequestDeny: value: action: deny approveDenyAccessRequestResponse: value: result: entityType: user entityId: 87654321 role: TEAM_DEVELOPER previousRole: null status: Accepted accessRequest: id: 1095 requestType: REQUEST_TO_ADD_MEMBERS reason: '' status: Accepted objectType: team objectId: 1095 createdBy: 87654321 approveDenyAccessRequestDenyResponse: value: result: entityType: user entityId: 87654321 role: TEAM_DEVELOPER status: Denied accessRequest: id: 1095 requestType: REQUEST_TO_ADD_MEMBERS reason: '' status: Denied objectType: team objectId: 1095 createdBy: 87654321 teams404ErrorAccessRequestNotFound: value: type: https://api.postman.com/problems/not-found status: 404 title: Not Found detail: error: name: EntityNotFound message: Access request not found or already processed. instance: /teams/123/access-requests/1095 manageTeamMemberRolesAssignTeamMemberRole: value: add: users: '12345678': - TEAM_MANAGER groups: '1234': - TEAM_DEVELOPER manageTeamMemberRolesUpdateTeamMemberRole: value: add: users: '12345678': - TEAM_MANAGER manageTeamMemberRolesUpdateTeamOrgRole: value: add: orgs: '432': - TEAM_GUEST_DEVELOPER manageTeamMemberRolesUpdateTeamRole: value: add: teams: '432': - TEAM_GUEST_DEVELOPER manageTeamMemberRolesUpdateTeamRoleScimId: value: add: teams: f10ba7a8dac248e8fd9769163dc63aef920f3897c7ea2c86: - TEAM_GUEST_DEVELOPER manageTeamMemberRolesRemoveTeamRole: value: remove: users: '12345678': - TEAM_DEVELOPER manageTeamMemberRolesAddRemoveRoles: value: add: users: '12345678': - TEAM_MANAGER remove: users: '87654321': - TEAM_DEVELOPER manageTeamMemberRolesAddRemoveRolesScimId: value: add: users: f10ba7a8dac248e8fd9769163dc63aef920f3897c7ea2c86: - TEAM_MANAGER remove: groups: gecb77b6c45c98602d6ae4458b46d4f30e3c423719636d87: - TEAM_DEVELOPER users: 7db6e2fba7e98f9db428a1735a71bbb4e4fbbaa37db37640: - TEAM_DEVELOPER manageTeamMemberRolesAssignTeamMemberRoleResponse: value: result: - entityType: user entityId: 12345678 role: TEAM_MANAGER previousRole: null status: Accepted - entityType: group entityId: 1234 role: TEAM_DEVELOPER previousRole: null status: Accepted manageTeamMemberRolesUpdateTeamMemberRoleResponse: value: result: - entityType: user entityId: 12345678 role: TEAM_MANAGER previousRole: TEAM_DEVELOPER status: Accepted manageTeamMemberRolesUpdateTeamOrgRoleResponse: value: result: - entityType: organization entityId: 345 role: TEAM_GUEST_DEVELOPER previousRole: TEAM_GUEST_VIEWER status: Accepted manageTeamMemberRolesUpdateTeamRoleResponse: value: result: - entityType: team entityId: 432 role: TEAM_GUEST_DEVELOPER previousRole: TEAM_GUEST_VIEWER status: Accepted manageTeamMemberRolesUpdateTeamRoleScimIdResponse: value: result: - entityType: user entityId: f10ba7a8dac248e8fd9769163dc63aef920f3897c7ea2c86 role: TEAM_MANAGER previousRole: TEAM_DEVELOPER status: Accepted manageTeamMemberRolesRemoveTeamRoleResponse: value: result: - entityType: user entityId: 12345678 role: null previousRole: TEAM_DEVELOPER status: Accepted manageTeamMemberRolesAddRemoveRolesResponse: value: result: - entityType: user entityId: 12345678 role: TEAM_MANAGER previousRole: null status: Accepted - entityType: user entityId: 87654321 role: null previousRole: TEAM_DEVELOPER status: Accepted manageTeamMemberRolesAddRemoveRolesScimIdResponse: value: result: - entityType: user entityId: 3c83d7cddf8470c6e5fb1cb52586a98d0d4200781107c535 role: TEAM_MANAGER previousRole: TEAM_DEVELOPER status: Accepted - entityType: group entityId: gecb77b6c45c98602d6ae4458b46d4f30e3c423719636d87 role: null previousRole: TEAM_DEVELOPER status: Accepted - entityType: user entityId: 7db6e2fba7e98f9db428a1735a71bbb4e4fbbaa37db37640 role: null previousRole: TEAM_DEVELOPER status: Accepted removeTeamMembersRemoveMembers: value: entities: - entityType: user entityId: '87654321' - entityType: user entityId: '56781234' removeTeamMembersRemoveOrganization: value: entities: - entityType: organization entityId: '456' removeTeamMembersRemoveTeam: value: entities: - entityType: team entityId: '432' removeTeamMembersRemoveMembersScimId: value: entities: - entityType: user entityId: f10ba7a8dac248e8fd9769163dc63aef920f3897c7ea2c86 - entityType: user entityId: 696e7061fe5aa0e7abb54851cdb0e3b21eed4f8daef24d13 removeTeamMembersRemoveUserAndGroupTeamMembers: value: entities: - entityType: user entityId: '12345678' - entityType: group entityId: '1234' createGetTeamSettingsResponse: value: settings: rfa_for_add_member: disabled rfa_for_add_collaborator: disabled updateTeamSettings: value: settings: rfa_for_add_member: enabled rfa_for_add_collaborator: enabled getTeamUsers: value: data: - id: 1 name: Taylor Lee username: taylor-lee email: taylor.lee@example.com roles: - admin - user joinedAt: '2022-11-23T14:38:25.000Z' - id: 2 name: Alex Cruz username: alex-cruz email: alex.cruz@example.com roles: - user joinedAt: '2022-11-24T10:18:11.000Z' getTeamUsersFilterGroup: value: data: - id: 1 name: Taylor Lee username: taylor-lee email: taylor.lee@example.com roles: - admin - user getTeamUsersNoGroupFound: value: data: [] getTeamUser: value: id: 1 name: Taylor Lee username: taylor-lee email: taylor.lee@example.com roles: - user - admin joinedAt: '2022-11-23T14:38:25.000Z' createWebhook: value: webhook: name: Test Webhook collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 createWebhookResponse: value: webhook: id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: Test Webhook collection: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 webhookUrl: https://newman-api.postman.com/run/12345678/267a6e99-b6da-407c-a96f-03be2d6282fb uid: 12345678-1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createWebhookParamMissing400Error: value: error: name: paramMissingError message: Parameter is missing in the request. details: param: - collection getWorkspaces: value: workspaces: - id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: My Workspace type: personal visibility: personal createdBy: '12345678' about: This is a personal workspace. createdAt: '2022-07-18T06:57:37.000Z' updatedAt: '2025-05-30T08:49:54.000Z' - id: a0f46158-1529-11ee-be56-0242ac120002 name: Private Workspace type: team visibility: private createdBy: '12345678' about: This is a private workspace. createdAt: '2022-07-18T06:57:37.000Z' updatedAt: '2025-05-30T08:49:54.000Z' - id: f8801e9e-03a4-4c7b-b31e-5db5cd771696 name: Team Workspace type: team visibility: team createdBy: '12345678' about: This is a team workspace. createdAt: '2022-07-18T06:57:37.000Z' updatedAt: '2025-05-30T08:49:54.000Z' - id: 74dbfab8-1529-11ee-be56-0242ac120002 name: Public Workspace type: team visibility: public createdBy: '12345678' about: This is a public workspace. createdAt: '2022-07-18T06:57:37.000Z' updatedAt: '2025-05-30T08:49:54.000Z' - id: 74dbfab8-1529-11ee-be56-0242ac120002 name: Partner Workspace type: team visibility: partner createdBy: '12345678' about: This is a partner workspace. createdAt: '2022-07-18T06:57:37.000Z' updatedAt: '2025-05-30T08:49:54.000Z' getWorkspacesIncludeScimIds: value: workspaces: - id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: My Workspace type: personal visibility: personal createdBy: '12345678' about: This is a personal workspace. scim: createdBy: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 createdAt: '2022-07-18T06:57:37.000Z' updatedAt: '2025-05-30T08:49:54.000Z' getWorkspacesPaginationResponse: value: workspaces: - id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: My Workspace type: personal visibility: personal createdBy: '12345678' about: This is a personal workspace. createdAt: '2022-07-18T06:57:37.000Z' updatedAt: '2025-05-30T08:49:54.000Z' - id: a0f46158-1529-11ee-be56-0242ac120002 name: Private Workspace type: team visibility: private createdBy: '12345678' about: This is a private workspace. createdAt: '2022-07-18T06:57:37.000Z' updatedAt: '2025-05-30T08:49:54.000Z' meta: nextCursor: NDgzMjY1 workspace400ErrorInvalidTypeFilter: value: error: name: invalidParamError message: visibilityStatus must be one of personal/private/team/public/partner statusCode: 400 workspace400ErrorMissingElementIdFilter: value: name: badRequest message: elementId is required when elementType is provided workspace400ErrorInvalidElementTypeFilter: value: name: badRequest message: 'elementType must be one of: collection, specification' workspace400ErrorInvalidLimitValue: value: error: name: badRequestError message: The limit parameter must not exceed 100. common429ErrorRateLimited: value: error: rateLimited message: Rate limit exceeded. Please retry after 1669048687 createWorkspace: value: workspace: name: Team Workspace type: team description: This is a team workspace. about: Team workspace. createWorkspaceInTeam: value: workspace: name: Team Workspace type: team description: This is a team workspace. about: Team workspace. teamId: '1234' createWorkspaceResponse: value: workspace: id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: Team Workspace workspace400ErrorMalformedRequest: value: error: name: malformedRequestError message: '''workspace'' object missing in the request' workspacePostPut400ErrorPublicPublishLimit: value: error: name: rateLimit message: team~1234 workspacePostPut400ErrorNotUniqueWorkspaceName: value: error: name: workspaceSlugNotUniqueError message: Workspace Slug is not unique in the account context workspacePostPut400ErrorMissingName: value: error: name: invalidParamError message: body should have required property 'name' workspace403ErrorUnauthorized: value: error: status: 403 name: forbiddenError message: You are not authorized to perform this action detail: You do not have permission to create team workspaces. instance: '' getAllWorkspaceRoles: value: roles: user: - id: '3' displayName: Admin description: Can manage people and all resources - id: '2' displayName: Editor description: Can create and edit all resources - id: '1' displayName: Viewer description: Can view and collaborate on all resources usergroup: - id: '3' displayName: Admin description: Can manage people and all resources - id: '2' displayName: Editor description: Can create and edit all resources - id: '1' displayName: Viewer description: Can view and collaborate on all resources partner: - id: '7' displayName: Editor and Partner Lead description: Can create and edit workspace resources, and invite partners with Editor or Viewer access to the workspace - id: '6' displayName: Viewer and Partner Lead description: Can view, fork and export workspace resources, and invite partners with Viewer access to the workspace - id: '5' displayName: Editor description: Can create, edit and fork workspace resources - id: '4' displayName: Viewer description: Can send requests and view workspace resources getWorkspace: value: workspace: id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: Team Workspace type: team description: This is a team workspace. visibility: team createdBy: '12345678' updatedBy: '12345678' createdAt: '2022-07-06T16:18:32.000Z' updatedAt: '2022-07-06T20:55:13.000Z' about: Team workspace. collections: - id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 environments: - id: 5daabc50-8451-43f6-922d-96b403b4f28e name: Test Environment uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e mocks: - id: e3d951bf-873f-49ac-a658-b2dcb91d3289 name: Test Mock uid: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289 deactivated: false monitors: - id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: Test Monitor uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 deactivated: false apis: - id: 387c2863-6ee3-4a56-8210-225f774edade name: Test API uid: 12345678-387c2863-6ee3-4a56-8210-225f774edade specs: - id: 73e15000-bc7a-4802-b80e-05fff18fd7f8 name: Sample API uid: 12345678-73e15000-bc7a-4802-b80e-05fff18fd7f8 getWorkspaceIncludeScimIds: value: workspace: id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: Team Workspace type: team description: This is a team workspace. visibility: team createdBy: '12345678' updatedBy: '12345678' createdAt: '2022-07-06T16:18:32.000Z' updatedAt: '2022-07-06T20:55:13.000Z' about: Team workspace. collections: - id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 environments: - id: 5daabc50-8451-43f6-922d-96b403b4f28e name: Test Environment uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e mocks: - id: e3d951bf-873f-49ac-a658-b2dcb91d3289 name: Test Mock uid: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289 deactivated: false monitors: - id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: Test Monitor uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 deactivated: false apis: - id: 387c2863-6ee3-4a56-8210-225f774edade name: Test API uid: 12345678-387c2863-6ee3-4a56-8210-225f774edade specs: - id: 73e15000-bc7a-4802-b80e-05fff18fd7f8 name: Sample API uid: 12345678-73e15000-bc7a-4802-b80e-05fff18fd7f8 scim: createdBy: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 updatedBy: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 getWorkspaceIncludeTeamScimId: value: id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: Team Workspace type: team description: This is a team workspace. visibility: team createdBy: '12345678' updatedBy: '12345678' teamId: '1' createdAt: '2022-07-06T16:18:32.000Z' updatedAt: '2022-07-06T20:55:13.000Z' about: Team workspace. collections: - id: 12ece9e1-2abf-4edc-8e34-de66e74114d2 name: Test Collection uid: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 environments: - id: 5daabc50-8451-43f6-922d-96b403b4f28e name: Test Environment uid: 12345678-5daabc50-8451-43f6-922d-96b403b4f28e mocks: - id: e3d951bf-873f-49ac-a658-b2dcb91d3289 name: Test Mock uid: 12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289 deactivated: false monitors: - id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 name: Test Monitor uid: 12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 deactivated: false apis: - id: 387c2863-6ee3-4a56-8210-225f774edade name: Test API uid: 12345678-387c2863-6ee3-4a56-8210-225f774edade specs: - id: 73e15000-bc7a-4802-b80e-05fff18fd7f8 name: Sample API uid: 12345678-73e15000-bc7a-4802-b80e-05fff18fd7f8 scim: createdBy: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 updatedBy: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 workspace404ErrorNotFound: value: error: name: workspaceNotFoundError message: Workspace not found statusCode: 404 updateWorkspace: value: workspace: name: Test Workspace type: team description: This is a test team workspace. about: Team workspace. updateWorkspaceNameDescription: value: workspace: name: Test Workspace description: This is a test team workspace. updateWorkspaceType: value: workspace: type: team updateWorkspaceResponse: value: workspace: id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 name: Test Workspace workspace403Error: value: error: name: forbiddenError message: You do not have access to update this workspace. workspace403ErrorToPublicForbidden: value: error: name: cannotConvertToPublicWorkspace message: Can not convert workspaces to public workspaces for team user. First convert to team. workspace403ErrorFromPublicForbidden: value: error: name: cannotConvertFromPublicWorkspace message: Can not convert workspaces from public workspaces for team user. First convert to team. instanceNotFoundWorkspace: value: error: name: instanceNotFoundError message: The specified workspace does not exist. deleteWorkspace: value: workspace: id: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 workspace400Error: value: error: name: instanceNotFoundError message: The specified workspace does not exist. getWorkspaceActivityFeed: value: meta: nextCursor: bmV4dDppZDpZWEpqYUdsMllXeEVRaXhtWldWa2MxOHlNREkxWHpFc01UTXpNelE0 data: - workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdAt: '2025-04-07T14:33:23Z' updatedAt: '2025-04-07T14:33:23Z' id: 15178 user: id: 12345678 username: research-physicist-12345678 isPartner: false name: Taylor Lee action: update elementType: collection trigger: update elementId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 elementName: Test API - workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdAt: '2025-04-07T14:33:23Z' updatedAt: '2025-04-07T14:33:23Z' id: 15177 user: id: 12345678 username: research-physicist-12345678 isPartner: false name: Taylor Lee action: update elementType: collection trigger: update elementId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 elementName: New Collection - workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdAt: '2025-04-07T13:59:02Z' updatedAt: '2025-04-07T13:59:02Z' id: 15131 user: id: 12345678 username: research-physicist-12345678 isPartner: false name: Taylor Lee action: update elementType: workspace trigger: update_visibility elementId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 elementName: Testing APIs - workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdAt: '2025-04-07T13:56:09Z' updatedAt: '2025-04-07T13:56:09Z' id: 15130 user: id: 12345678 username: research-physicist-12345678 isPartner: false name: Taylor Lee action: update elementType: workspace trigger: add_user_role elementId: 47574adc-85bc-42f3-8723-17106ec6fac8 elementName: Testing APIs - workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdAt: '2025-04-07T13:54:07Z' updatedAt: '2025-04-07T13:54:07Z' id: 15125 user: id: 12345678 username: research-physicist-12345678 isPartner: false name: Taylor Lee action: destroy elementType: collection trigger: destroy elementid: 12345678-e562f717-596b-4d3a-80d9-0aaa44a8f900 elementName: Billing API - workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdAt: '2025-04-07T13:52:53Z' updatedAt: '2025-04-07T13:53:34Z' id: 15122 user: id: 12345678 username: research-physicist-12345678 isPartner: false name: Taylor Lee action: update elementType: collection trigger: update elementId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 elementName: New Collection - workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdAt: '2025-04-07T13:52:43Z' updatedAt: '2025-04-07T13:52:43Z' id: 15117 user: id: 12345678 username: research-physicist-12345678 isPartner: false name: Taylor Lee action: create elementType: collection trigger: create elementId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 elementName: New Collection - workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdAt: '2025-03-24T17:00:09Z' updatedAt: '2025-03-24T17:00:09Z' id: 133348 user: id: 12345678 username: research-physicist-12345678 isPartner: false name: Taylor Lee action: create elementType: collection trigger: create elementid: 12345678-e562f717-596b-4d3a-80d9-0aaa44a8f900 elementName: Billing API getWorkspaceActivityFeedByElement: value: meta: nextCursor: '' data: - workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdAt: '2025-04-07T13:59:02Z' updatedAt: '2025-04-07T13:59:02Z' id: 15131 user: id: 12345678 username: research-physicist-12345678 isPartner: false name: Taylor Lee action: update elementType: workspace trigger: update_visibility elementId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 elementName: Testing APIs - workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdAt: '2025-04-07T13:56:09Z' updatedAt: '2025-04-07T13:56:09Z' id: 15130 user: id: 12345678 username: research-physicist-12345678 isPartner: false name: Taylor Lee action: update elementType: workspace trigger: add_user_role elementId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 elementName: Testing APIs workspaceFeed400Error: value: type: https://api.postman.com/problems/bad-request title: Bad Request detail: querystring.limit should be integer status: 400 workspaceFeed400ErrorUserId: value: type: https://api.postman.com/problems/bad-request title: Bad Request detail: User ID must be an integer. status: 400 workspaceCommon404Error: value: type: https://api.postman.com/problems/not-found title: Not Found detail: Workspace not found status: 404 transferWorkspaceElementCollection: value: id: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 type: collection to: d56bc95f-57c5-47cc-bd99-75c4ad96a6dd transferWorkspaceElementEnvironment: value: id: 5daabc50-8451-43f6-922d-96b403b4f28e type: environment to: d56bc95f-57c5-47cc-bd99-75c4ad96a6dd transferWorkspaceElementFlow: value: id: 68640e3433ea760031f7b16c type: flow to: d56bc95f-57c5-47cc-bd99-75c4ad96a6dd transferWorkspaceElementMock: value: id: e3d951bf-873f-49ac-a658-b2dcb91d3289 type: mock to: d56bc95f-57c5-47cc-bd99-75c4ad96a6dd transferWorkspaceElementMonitor: value: id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 type: monitor to: d56bc95f-57c5-47cc-bd99-75c4ad96a6dd transferWorkspaceElementApiResponse: value: workspace: element-transfers: to: d56bc95f-57c5-47cc-bd99-75c4ad96a6dd from: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 id: 8b6ea58b-fd33-4678-bdab-67734b3ed6b0 type: api transferWorkspaceElementCollectionResponse: value: workspace: element-transfers: to: d56bc95f-57c5-47cc-bd99-75c4ad96a6dd from: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 id: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 type: collection transferWorkspaceElementFlowResponse: value: workspace: element-transfers: to: d56bc95f-57c5-47cc-bd99-75c4ad96a6dd from: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 id: 68640e3433ea760031f7b16c type: flow transferWorkspaceElementEnvironmentResponse: value: workspace: element-transfers: to: d56bc95f-57c5-47cc-bd99-75c4ad96a6dd from: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 id: 5daabc50-8451-43f6-922d-96b403b4f28e type: environment transferWorkspaceElementMockResponse: value: workspace: element-transfers: to: d56bc95f-57c5-47cc-bd99-75c4ad96a6dd from: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 id: e3d951bf-873f-49ac-a658-b2dcb91d3289 type: mock transferWorkspaceElementMonitorResponse: value: workspace: element-transfers: to: d56bc95f-57c5-47cc-bd99-75c4ad96a6dd from: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 id: 1e6b6cc1-c760-48e0-968f-4bfaeeae9af1 type: monitor transferWorkspaceElement400ErrorTeamPersonalInvalid: value: type: https://api.postman.com/problems/bad-request title: Bad Request status: 400 detail: Cannot move elements from team level workspace to personal transferWorkspaceElement400ErrorInvalidType: value: type: https://api.postman.com/problems/bad-request title: Bad Request status: 400 detail: element type is not register or is falsy transferWorkspaceElement400ErrorMissingId: value: type: https://api.postman.com/problems/bad-request title: Bad Request status: 400 detail: The 'id' property is required transferWorkspaceElement400ErrorMissingTo: value: type: https://api.postman.com/problems/bad-request title: Bad Request status: 400 detail: The 'to' property is required transferWorkspaceElement400ErrorMissingType: value: type: https://api.postman.com/problems/bad-request title: Bad Request status: 400 detail: The 'type' property is required getWorkspaceGlobalVariables: value: values: - key: x-api-key type: secret value: '{{postman-api-key}}' enabled: true description: A valid Postman API key. - key: collectionId type: default value: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 enabled: true description: The collection's ID. globalVariables500Error: value: type: https://api.postman.com/problems/servererror title: Internal server error detail: Details about the error updateWorkspaceGlobalVariables: value: values: - key: x-api-key value: '{{postman-api-key}}' type: secret enabled: true description: A valid Postman API key. - key: collectionId value: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 type: default enabled: true description: The collection's ID. updateWorkspaceGlobalVariablesResponse: value: values: - key: x-api-key type: secret value: '{{postman-api-key}}' enabled: true description: A valid Postman API key. - key: collectionId type: default value: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 enabled: true description: The collection's ID. workspaceRoles: value: roles: - id: '1' displayName: Viewer user: - '12345678' - id: '3' displayName: Admin group: - '56781234' - id: '5' displayName: Editor partner: - '43215678' workspaceRolesScimIds: value: roles: - id: '3' displayName: Admin user: - 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 group: - 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00 partner: - '43215678' updateUserRole: value: roles: - op: add path: /user value: - id: '12345678' role: '1' - id: '87654321' role: '2' - op: remove path: /user value: - id: '87612345' role: '1' - op: add path: /usergroup value: - id: '123' role: '2' - op: remove path: /usergroup value: - id: '312' role: '3' updateRoleSCIMId: value: roles: - op: add path: /user value: - id: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 role: '1' updateRoleGroupSCIMId: value: roles: - op: add path: /user value: - id: 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 role: '3' - op: add path: /usergroup value: - id: 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00 role: '3' addWorkspaceGroupRole: value: roles: - op: add path: /usergroup value: - id: '1234' role: '3' removeWorkspaceGroupRole: value: roles: - op: remove path: /usergroup value: - id: '1234' role: '3' addRemovePartnerRoles: value: roles: - op: add path: /partner value: - id: '87654321' role: '4' - op: remove path: /partner value: - id: '43215678' role: '4' userRoleUpdated: value: roles: - id: '1' displayName: Viewer user: - '12345678' group: - '123' - id: '2' displayName: Editor user: - '87654321' group: - '123' - id: '3' displayName: Admin user: - '13428756' group: - '132' userRoleUpdatedSCIMId: value: roles: - id: '1' displayName: Viewer user: - 405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99 userRoleGroupUpdatedSCIMId: value: roles: - id: '3' displayName: Admin user: - e982929dadd02cf627e8c111925fc37a93dbc86f510840db group: - 561631fq14ed41872a8eea4c8aa2b38cda9749812cc55c00 workspaceRolesAddRemovePartnerRole: value: roles: - id: '4' displayName: Viewer partner: - '87654321' workspaceRoles400Error: value: type: invalidParamError title: body.roles[0] should have required property 'op' detail: '' status: 400 workspaceRoles400ErrorInvalidMultiPartnerRole: value: type: https://api.postman.com/problems/bad-request title: Invalid Request. detail: Role is invalid for multi partner workspace. status: 400 workspaceRoles400ErrorCannotUpdateUserPartnerRoles: value: type: https://api.postman.com/problems/bad-request title: Invalid Request. detail: Only one of user or partner roles can be modified at a time. status: 400 workspaceRoles400ErrorMissingOperationPartnerRoleUpdate: value: type: https://api.postman.com/problems/bad-request title: Invalid Request. detail: 'Partner role update requires exactly two operations: one add and one remove.' status: 400 workspaceRoles422Error: value: detail: Roles are not supported for personal workspaces. link: https://api.postman.com/problems/unprocessable-entity status: 422 title: Cannot process the request. transferWorkspaceToTeam: value: source: d56bc95f-57c5-47cc-bd99-75c4ad96a6dd destination: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 transferWorkspaceToTeamResponse: value: workspace: transfer: id: 8b6ea58b-fd33-4678-bdab-67734b3ed6b0 source: d56bc95f-57c5-47cc-bd99-75c4ad96a6dd destination: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 transferWorkspaceToTeam400Error: value: type: https://api.postman.com/problems/bad-request title: Invalid Request Body detail: The 'destination' property is required status: 400 common500ErrorServerErrorOccurred: value: type: https://api.postman.com/problems/internal-server-error title: Internal Server Error detail: An error has occurred on the server. status: 500 getWorkspaceUpdates: value: data: - id: 1 topic: API v1.0 released description: We've released the first version of our newest API! workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdBy: id: 12345678 name: Taylor Lee username: taylor-lee updatedBy: 12345678 createdAt: '2026-04-10T09:36:21.000Z' updatedAt: '2026-04-10T11:58:43.000Z' category: announcement isPinned: true relatedResources: - resource: collection resourceId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 meta: nextCursor: e3BhZ2VJZDoyfQ== getWorkspaceUpdatesFilters: value: data: - id: 1 topic: API v1.0 released description: We've released the first version of our newest API! workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdBy: id: 12345678 name: Taylor Lee username: taylor-lee updatedBy: 12345678 createdAt: '2026-04-10T09:36:21.000Z' updatedAt: '2026-04-10T11:58:43.000Z' category: announcement isPinned: true relatedResources: - resource: collection resourceId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 - id: 2 topic: API v1.0.1 release description: We've updated our API with several minor improvements. workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdBy: id: 56781234 name: Alex Cruz username: alex-cruz updatedBy: 12345678 createdAt: '2026-04-20T20:12:46.000Z' updatedAt: '2026-04-20T20:12:46.000Z' category: improvement isPinned: false relatedResources: [] meta: nextCursor: null workspaceUpdates400ErrorBadRequestInvalidRequestBody: value: type: https://api.postman.com/problems/badRequest title: Bad Request status: 400 detail: Invalid request body workspaceUpdates400ErrorInvalidCategory: value: type: https://api.postman.com/problems/badRequest title: Bad Request status: 400 detail: Invalid request body. ["should have required property 'category'"] workspaceUpdates400ErrorInvalidUpdateCategory: value: type: https://api.postman.com/problems/invalidWorkspaceUpdateCategory title: Bad Request status: 400 detail: 'Invalid ''category'' — must be one of: improvement, new_feature, bug_fix, breaking_change, announcement' workspaceUpdates401ErrorGetPatchDeleteUnauthorized: value: detail: Unauthorized status: 401 instance: /workspaces/1f0df51a-8658-4ee8-a2a1-d2567dfa09a9/updates/1 title: Unauthorized type: https://api.postman.com/problems/unauthorized workspaceUpdates401ErrorGetAllPostUnauthorized: value: type: https://api.postman.com/problems/unauthorized title: Unauthorized detail: Unauthorized status: 401 instance: /workspaces/1f0df51a-8658-4ee8-a2a1-d2567dfa09a9/updates workspaceUpdates403ErrorCreateUpdateForbidden: value: type: https://api.postman.com/problems/forbidden title: Forbidden detail: You are not authorized to create an update on this workspace. status: 403 workspaceUpdates403ErrorUpdateForbidden: value: type: https://api.postman.com/problems/forbidden title: Forbidden status: 403 detail: You are not authorized to update this workspace update. workspaceUpdates403ErrorViewUpdateForbidden: value: type: https://api.postman.com/problems/forbidden title: Forbidden detail: You are not authorized to view update on this workspace. status: 403 workspaceUpdates403ErrorDeleteUpdateForbidden: value: type: https://api.postman.com/problems/forbidden title: Forbidden detail: You are not authorized to delete this workspace update. status: 403 workspaceUpdates404ErrorEntityNotFound: value: type: https://api.postman.com/problems/notFound title: Not Found status: 404 detail: Entity does not exist workspaceUpdates404ErrorWorkspaceUpdateNotFound: value: type: https://api.postman.com/problems/notFound title: Not Found status: 404 detail: Workspace Update does not exist workspaceUpdates404ErrorWorkspaceNotFound: value: type: https://api.postman.com/problems/notFound title: Not Found detail: Workspace does not exist status: 404 createWorkspaceUpdate: value: topic: API v1.0 released description: We've released the first version of our newest API! category: announcement relatedResources: - resource: collection resourceId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 workspaceUpdates422ErrorUnprocessableContent: value: type: https://api.postman.com/problems/unprocessableContent title: Unprocessable content status: 422 detail: This content violates our terms of service. getWorkspaceUpdate: value: id: 1 topic: API v1.0 released description: We've released the first version of our newest API! workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdBy: id: 12345678 name: Taylor Lee username: taylor-lee updatedBy: 12345678 createdAt: '2026-04-10T09:36:21.000Z' updatedAt: '2026-04-10T11:58:43.000Z' category: announcement isPinned: true relatedResources: - resource: collection resourceId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 updateWorkspaceUpdate: value: topic: API v1.0 released description: We've released the first version of our newest API! category: announcement isPinned: true relatedResources: - resource: collection resourceId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 updateWorkspaceUpdateResponse: value: id: 1 topic: API v1.0 released description: We've released the first version of our newest API! workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdBy: 12345678 updatedBy: 12345678 createdAt: '2026-04-10T09:36:21.000Z' updatedAt: '2026-04-10T11:58:43.000Z' category: announcement isPinned: true relatedResources: - resource: collection resourceId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 workspaceUpdates415ErrorUnsupportedMediaType: value: type: https://api.postman.com/problems/unsupportedMediaType title: Unsupported Media Type status: 415 detail: Content-Type must be application/merge-patch+json. responses: getAccounts: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/invoicesAccountInfo' examples: Successful Response: $ref: '#/components/examples/getAccounts' invoices400Error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Not Part of Team: $ref: '#/components/examples/invoices400ErrorNotPartOfTeam' Bad Request: $ref: '#/components/examples/invoices400ErrorBadRequest' common401Error: description: Unauthorized content: application/problem+json: schema: anyOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' examples: Unauthorized: $ref: '#/components/examples/common401Error' Authentication Error: $ref: '#/components/examples/common401ErrorAuthentication' Invalid API Key: $ref: '#/components/examples/common401ErrorInvalidApiKey' Missing API Key: $ref: '#/components/examples/common401ErrorMissingApiKey' Not Authorized: $ref: '#/components/examples/common401ErrorNotAuthorized' common500Error: description: Internal Server Error content: application/problem+json: schema: anyOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' examples: Internal Server Error: $ref: '#/components/examples/common500ErrorInternalServer' Internal Error: $ref: '#/components/examples/common500ErrorDetail' Server Error: $ref: '#/components/examples/common500ErrorServerError' Something Went Wrong: $ref: '#/components/examples/common500ErrorSomethingWrong' Contact Support: $ref: '#/components/examples/common500ErrorSomethingWrongContactSupport' getAccountInvoices: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getAccountInvoices' examples: Successful Response: $ref: '#/components/examples/getAccountInvoicesSuccessfulResponse' No Invoices: $ref: '#/components/examples/getAccountInvoicesNoInvoices' invoices403Error: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Forbidden: $ref: '#/components/examples/invoices403ErrorForbidden' Invalid Account ID: $ref: '#/components/examples/invoices403ErrorInvalidAccountId' getAnalyticsData: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getAnalyticsData' examples: Users - Active Users - Top 5 Users: $ref: '#/components/examples/getAnalyticsDataUsersActiveUsersTop5Users' Users - Active Users - Count Trend: $ref: '#/components/examples/getAnalyticsDataUsersActiveUsersCountTrend' Workspace Active Users - Count - Internal Workspace: $ref: '#/components/examples/getAnalyticsDataWorkspaceActiveUsersCountInternalWorkspace' Workspace - Elements: $ref: '#/components/examples/getAnalyticsDataWorkspaceElements' Workspace - Elements - Internal Workspaces: $ref: '#/components/examples/getAnalyticsDataWorkspaceElementsInternalWorkspaces' Workspace - Active Workspace: $ref: '#/components/examples/getAnalyticsDataWorkspaceActiveWorkspace' Workspace - Active Workspaces - Internal Workspaces: $ref: '#/components/examples/getAnalyticsDataWorkspaceActiveWorkspacesInternalWorkspaces' Workspace - Active - Count Trend: $ref: '#/components/examples/getAnalyticsDataWorkspaceActiveCountTrend' Workspace - Active - Count Trend - Internal Workspace: $ref: '#/components/examples/getAnalyticsDataWorkspaceActiveCountTrendInternalWorkspace' Workspace - Active Users - Count - Internal Workspace: $ref: '#/components/examples/getAnalyticsDataWorkspaceActiveUsersCountInternalWorkspace2' Workspace - API Calls - Count Trend: $ref: '#/components/examples/getAnalyticsDataWorkspaceAPICallsCountTrend' Workspace - API Calls - Count Trend - Internal Workspace: $ref: '#/components/examples/getAnalyticsDataWorkspaceAPICallsCountTrendInternalWorkspace' Workspace - Active Collections: $ref: '#/components/examples/getAnalyticsDataWorkspaceActiveCollections' Workspace - Active Collections - Internal Workspaces: $ref: '#/components/examples/getAnalyticsDataWorkspaceActiveCollectionsInternalWorkspaces' Workspace - Response Status Trend: $ref: '#/components/examples/getAnalyticsDataWorkspaceResponseStatusTrend' Workspace - Response Status Trend - Internal WS: $ref: '#/components/examples/getAnalyticsDataWorkspaceResponseStatusTrendInternalWS' Workspace - Collection Error Rate: $ref: '#/components/examples/getAnalyticsDataWorkspaceCollectionErrorRate' Team - User API Journey Trend: $ref: '#/components/examples/getAnalyticsDataTeamUserAPIJourneyTrend' Team - Workspace Distribution Trend: $ref: '#/components/examples/getAnalyticsDataTeamWorkspaceDistributionTrend' Team - Internal Workspace Distribution Trend: $ref: '#/components/examples/getAnalyticsDataTeamInternalWorkspaceDistributionTrend' Team - License Consumption Trend: $ref: '#/components/examples/getAnalyticsDataTeamLicenseConsumptionTrend' Team - Last Autoflex Cycle - Detailed: $ref: '#/components/examples/getAnalyticsDataTeamLastAutoflexCycleDetailed' Team - Members - Detailed: $ref: '#/components/examples/getAnalyticsDataTeamMembersDetailed' Team - Members Overtime - Trend: $ref: '#/components/examples/getAnalyticsDataTeamMembersOvertimeTrend' Team - Member Invites - Trend: $ref: '#/components/examples/getAnalyticsDataTeamMemberInvitesTrend' Team - Member Invites Sent - Detailed: $ref: '#/components/examples/getAnalyticsDataTeamMemberInvitesSentDetailed' Team - Member Invites Accepted - Detailed: $ref: '#/components/examples/getAnalyticsDataTeamMemberInvitesAcceptedDetailed' Partner Workspace - Pending Invites Count: $ref: '#/components/examples/getAnalyticsDataPartnerWorkspacePendingInvitesCount' Partner Workspace - Pending Invites: $ref: '#/components/examples/getAnalyticsDataPartnerWorkspacePendingInvites' Partner Workspace - Needs Attention - Count: $ref: '#/components/examples/getAnalyticsDataPartnerWorkspaceNeedsAttentionCount' Partner Workspace - Needs Attention: $ref: '#/components/examples/getAnalyticsDataPartnerWorkspaceNeedsAttention' Partner Workspace - API Success Rate - Trend: $ref: '#/components/examples/getAnalyticsDataPartnerWorkspaceAPISuccessRateTrend' Partner Workspace - API Success Rate - Detailed: $ref: '#/components/examples/getAnalyticsDataPartnerWorkspaceAPISuccessRateDetailed' Partner Workspace - User Requests - Selected Users: $ref: '#/components/examples/getAnalyticsDataPartnerWorkspaceUserRequestsSelectedUsers' Partner Workspace - User Requests - Selected Requests: $ref: '#/components/examples/getAnalyticsDataPartnerWorkspaceUserRequestsSelectedRequests' Partner Workspace - User Requests - Selected Response Status: $ref: '#/components/examples/getAnalyticsDataPartnerWorkspaceUserRequestsSelectedResponseStatus' Partner Workspace - Needs Attention - Attention Type: $ref: '#/components/examples/getAnalyticsDataPartnerWorkspaceNeedsAttentionAttentionType' Partner Workspace - Partner Engagement Funnel - Detailed: $ref: '#/components/examples/getAnalyticsDataPartnerWorkspacePartnerEngagementFunnelDetailed' Partner Workspace - Partner Engagement Funnel - Summary: $ref: '#/components/examples/getAnalyticsDataPartnerWorkspacePartnerEngagementFunnelSummary' AI - Top Models Detailed: $ref: '#/components/examples/getAnalyticsDataAITopModelsDetailed' AI - Activity Distribution: $ref: '#/components/examples/getAnalyticsDataAIActivityDistribution' AI - Peak Activity: $ref: '#/components/examples/getAnalyticsDataAIPeakActivity' AI - Ranked Usage Leaderboard - Filter User: $ref: '#/components/examples/getAnalyticsDataAIRankedUsageLeaderboardFilterUser' AI - Ranked Usage Leaderboard: $ref: '#/components/examples/getAnalyticsDataAIRankedUsageLeaderboard' AI - Model Credit Usage by Model Trend: $ref: '#/components/examples/getAnalyticsDataAIModelCreditUsageByModelTrend' AI - Credit Usage Summary: $ref: '#/components/examples/getAnalyticsDataAICreditUsageSummary' AI - Messages Sent Trend: $ref: '#/components/examples/getAnalyticsDataAIMessagesSentTrend' AI - Messages Sent Summary: $ref: '#/components/examples/getAnalyticsDataAIMessagesSentSummary' AI - Agent Mode Sessions Trend: $ref: '#/components/examples/getAnalyticsDataAIAgentModeSessionsTrend' AI - Agent Mode Sessions Summary: $ref: '#/components/examples/getAnalyticsDataAIAgentModeSessionsSummary' AI - New vs Returning Users Detailed: $ref: '#/components/examples/getAnalyticsDataAINewVsReturningUsersDetailed' AI - New vs Returning Summary: $ref: '#/components/examples/getAnalyticsDataAINewVsReturningSummary' AI - New vs Returning Trend: $ref: '#/components/examples/getAnalyticsDataAINewVsReturningTrend' AI - Agent Mode Users Trend: $ref: '#/components/examples/getAnalyticsDataAIAgentModeUsersTrend' AI - Agent Mode Users Summary: $ref: '#/components/examples/getAnalyticsDataAIAgentModeUsersSummary' API Management - Popular Workspaces - Detailed: $ref: '#/components/examples/getAnalyticsDataAPIManagementPopularWorkspacesDetailed' API Management - Workspace Activity - Trend: $ref: '#/components/examples/getAnalyticsDataAPIManagementWorkspaceActivityTrend' API Management - Workspace Activity - Summary: $ref: '#/components/examples/getAnalyticsDataAPIManagementWorkspaceActivitySummary' API Distribution - Public - Detailed: $ref: '#/components/examples/getAnalyticsDataAPIDistributionPublicDetailed' API Distribution - Public - Summary: $ref: '#/components/examples/getAnalyticsDataAPIDistributionPublicSummary' API Distribution - Partner - Detailed: $ref: '#/components/examples/getAnalyticsDataAPIDistributionPartnerDetailed' API Distribution - Partner - Summary: $ref: '#/components/examples/getAnalyticsDataAPIDistributionPartnerSummary' API Distribution - Private Network - Detailed: $ref: '#/components/examples/getAnalyticsDataAPIDistributionPrivateNetworkDetailed' API Distribution - Private Network - Summary: $ref: '#/components/examples/getAnalyticsDataAPIDistributionPrivateNetworkSummary' API Distribution - Active Workspaces - Trend: $ref: '#/components/examples/getAnalyticsDataAPIDistributionActiveWorkspacesTrend' API Distribution - Active Workspaces - Summary: $ref: '#/components/examples/getAnalyticsDataAPIDistributionActiveWorkspacesSummary' API Production - Flow Runs - Detailed: $ref: '#/components/examples/getAnalyticsDataAPIProductionFlowRunsDetailed' API Production - Flow Runs - Trend: $ref: '#/components/examples/getAnalyticsDataAPIProductionFlowRunsTrend' API Production - Flow Runs - Summary: $ref: '#/components/examples/getAnalyticsDataAPIProductionFlowRunsSummary' API Production - Monitor Runs - Detailed: $ref: '#/components/examples/getAnalyticsDataAPIProductionMonitorRunsDetailed' API Production - Monitor Runs - Trend: $ref: '#/components/examples/getAnalyticsDataAPIProductionMonitorRunsTrend' API Production - Monitor Runs - Summary: $ref: '#/components/examples/getAnalyticsDataAPIProductionMonitorRunsSummary' API Testing - Performance Test Runs - Detailed: $ref: '#/components/examples/getAnalyticsDataAPITestingPerformanceTestRunsDetailed' API Testing - Performance Test Runs - Trend: $ref: '#/components/examples/getAnalyticsDataAPITestingPerformanceTestRunsTrend' API Testing - Performance Test Runs - Summary: $ref: '#/components/examples/getAnalyticsDataAPITestingPerformanceTestRunsSummary' API Testing - Functional Test Runs - Detailed: $ref: '#/components/examples/getAnalyticsDataAPITestingFunctionalTestRunsDetailed' API Testing - Functional Test Runs - Trend: $ref: '#/components/examples/getAnalyticsDataAPITestingFunctionalTestRunsTrend' API Testing - Functional Test Runs - Summary: $ref: '#/components/examples/getAnalyticsDataAPITestingFunctionalTestRunsSummary' API Testing - Runs - Trend: $ref: '#/components/examples/getAnalyticsDataAPITestingRunsTrend' API Testing - Runs - Summary: $ref: '#/components/examples/getAnalyticsDataAPITestingRunsSummary' API Development - Top Entities - Detailed: $ref: '#/components/examples/getAnalyticsDataAPIDevelopmentTopEntitiesDetailed' API Development - Entity Activity - Detailed: $ref: '#/components/examples/getAnalyticsDataAPIDevelopmentEntityActivityDetailed' API Development - Entity Activity - Trend: $ref: '#/components/examples/getAnalyticsDataAPIDevelopmentEntityActivityTrend' API Development - Entity Activity - Summary: $ref: '#/components/examples/getAnalyticsDataAPIDevelopmentEntityActivitySummary' API Development - Active Workspaces - Trend: $ref: '#/components/examples/getAnalyticsDataAPIDevelopmentActiveWorkspacesTrend' API Development - Active Workspaces - Summary: $ref: '#/components/examples/getAnalyticsDataAPIDevelopmentActiveWorkspacesSummary' analytics400Error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Invalid Resource-Metric Pair: $ref: '#/components/examples/analytics400ErrorInvalidResourceMetricPair' Invalid Metric: $ref: '#/components/examples/analytics400ErrorInvalidMetric' analytics401Error: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Unauthorized: $ref: '#/components/examples/analytics401Error' analytics403Error: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Forbidden: $ref: '#/components/examples/analytics403Error' getAnalyticsMetadata: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getAnalyticsMetadata' examples: Successful Response: $ref: '#/components/examples/getAnalyticsMetadataSuccessfulResponse' Fitler Results by Metrics: $ref: '#/components/examples/getAnalyticsMetadataFitlerResultsByMetrics' Fitler Results by Team Resource: $ref: '#/components/examples/getAnalyticsMetadataFitlerResultsByTeamResource' Fitler Results by Resource with Parameters and Response Data: $ref: '#/components/examples/getAnalyticsMetadataFitlerResultsByResourceWithParametersAndResponseData' getApiCatalogDiscoveryServices: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApiCatalogDiscoveryServices' examples: Successful Response: $ref: '#/components/examples/getApiCatalogDiscoveryServicesSuccessfulResponse' Filter by status: $ref: '#/components/examples/getApiCatalogDiscoveryServicesFilterByStatus' Filter by search: $ref: '#/components/examples/getApiCatalogDiscoveryServicesFilterBySearch' Filter by discoverySource: $ref: '#/components/examples/getApiCatalogDiscoveryServicesFilterByDiscoverySource' Response with limit and cursor: $ref: '#/components/examples/getApiCatalogDiscoveryServicesResponseWithLimitAndCursor' No Results Found: $ref: '#/components/examples/getApiCatalogDiscoveryServicesNoResultsFound' getApiCatalogDiscoveryServices400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/apiCatalogError' examples: Invalid Status: $ref: '#/components/examples/getApiCatalogDiscoveryServices400Error' apiCatalog401Error: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Unauthorized: $ref: '#/components/examples/common401ErrorAuthenticationRequired' apiCatalog403Error: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Feature Disabled: $ref: '#/components/examples/common403ErrorFeatureDisabled' postApiCatalogDiscoveryServicesResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/postApiCatalogDiscoveryServicesResponse' examples: Add a Discovered Service: $ref: '#/components/examples/postApiCatalogDiscoveryServicesAddADiscoveredService' Add a Fully-Populated Service: $ref: '#/components/examples/postApiCatalogDiscoveryServicesAddAFullyPopulatedService' Add Service with an OpenAPI Specification: $ref: '#/components/examples/postApiCatalogDiscoveryServicesAddServiceWithAnOpenAPISpecification' Add Multiple Services: $ref: '#/components/examples/postApiCatalogDiscoveryServicesAddMultipleServicesResponse' Add Multiple Services with OpenAPI Specifications and Endpoints: $ref: '#/components/examples/postApiCatalogDiscoveryServicesAddMultipleServicesWithOpenAPISpecificationsAndEndpoints' postApiCatalogDiscoveryServices400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/apiCatalogError' examples: Bad Request: $ref: '#/components/examples/postApiCatalogDiscoveryServices400Error' Payload Limit Exceeded: $ref: '#/components/examples/postApiCatalogDiscoveryServices400ErrorPayloadLimitExceeded' getApiCatalogDiscoveryService: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApiCatalogDiscoveryService' examples: Successful Response: $ref: '#/components/examples/getApiCatalogDiscoveryServiceSuccessfulResponse' getApiCatalogServices: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApiCatalogServices' examples: Successful Response: $ref: '#/components/examples/getApiCatalogServicesSuccessfulResponse' Response with Pagination: $ref: '#/components/examples/getApiCatalogServicesResponseWithPagination' Filter by governanceGroupId: $ref: '#/components/examples/getApiCatalogServicesFilterByGovernanceGroupId' Filter by tags: $ref: '#/components/examples/getApiCatalogServicesFilterByTags' Filter by name: $ref: '#/components/examples/getApiCatalogServicesFilterByName' getApiCatalogService400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/apiCatalogError' examples: System Environment ID Invalid: $ref: '#/components/examples/apiCatalogService400ErrorSystemEnvironmentIdInvalid' Option Invalid: $ref: '#/components/examples/apiCatalogService400ErrorOptionInvalid' getApiCatalogService: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApiCatalogService' examples: Successful Response: $ref: '#/components/examples/getApiCatalogServiceSuccessfulResponse' apiCatalogService404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Feature Required: $ref: '#/components/examples/apiCatalogService404ErrorServiceNotFound' getApiCatalogServiceEndpoints: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApiCatalogServiceEndpoints' examples: Successful Response: $ref: '#/components/examples/getApiCatalogServiceEndpointsSuccessfulResponse' Response with Pagination: $ref: '#/components/examples/getApiCatalogServiceEndpointsResponseWithPagination' Sort Results by Error Rate: $ref: '#/components/examples/getApiCatalogServiceEndpointsSortResultsByErrorRate' Filter by responseCodes: $ref: '#/components/examples/getApiCatalogServiceEndpointsFilterByResponseCodes' Filter by search: $ref: '#/components/examples/getApiCatalogServiceEndpointsFilterBySearch' Filter by hosts: $ref: '#/components/examples/getApiCatalogServiceEndpointsFilterByHosts' Filter by httpMethods: $ref: '#/components/examples/getApiCatalogServiceEndpointsFilterByHttpMethods' getApiCatalogServiceMonitorRuns: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApiCatalogServiceMonitorRuns' examples: Successful Response: $ref: '#/components/examples/getApiCatalogServiceMonitorRunsSuccessfulResponse' Response with Pagination: $ref: '#/components/examples/getApiCatalogServiceMonitorRunsResponseWithPagination' Filter with sort: $ref: '#/components/examples/getApiCatalogServiceMonitorRunsFilterWithSort' Filter by environmentId: $ref: '#/components/examples/getApiCatalogServiceMonitorRunsFilterByEnvironmentId' Filter by status: $ref: '#/components/examples/getApiCatalogServiceMonitorRunsFilterByStatus' Filter by collectionId: $ref: '#/components/examples/getApiCatalogServiceMonitorRunsFilterByCollectionId' getApiCatalogServiceSpecificationLints: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApiCatalogServiceSpecificationLints' examples: Successful Response: $ref: '#/components/examples/getApiCatalogServiceSpecificationLintsSuccessfulResponse' Response with Pagination: $ref: '#/components/examples/getApiCatalogServiceSpecificationLintsResponseWithPagination' Filter with sort: $ref: '#/components/examples/getApiCatalogServiceSpecificationLintsFilterWithSort' Filter by specId: $ref: '#/components/examples/getApiCatalogServiceSpecificationLintsFilterBySpecId' Filter by status: $ref: '#/components/examples/getApiCatalogServiceSpecificationLintsFilterByStatus' Filter by severity: $ref: '#/components/examples/getApiCatalogServiceSpecificationLintsFilterBySeverity' getApiCatalogServiceCiRuns: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApiCatalogServiceCiRuns' examples: Successful Response: $ref: '#/components/examples/getApiCatalogServiceCiRunsSuccessfulResponse' Response with Pagination: $ref: '#/components/examples/getApiCatalogServiceCiRunsResponseWithPagination' Filter by collection: $ref: '#/components/examples/getApiCatalogServiceCiRunsFilterByCollection' Filter by environment: $ref: '#/components/examples/getApiCatalogServiceCiRunsFilterByEnvironment' Filter by workflowName: $ref: '#/components/examples/getApiCatalogServiceCiRunsFilterByWorkflowName' Filter by actor: $ref: '#/components/examples/getApiCatalogServiceCiRunsFilterByActor' Filter by repoName: $ref: '#/components/examples/getApiCatalogServiceCiRunsFilterByRepoName' Filter with sort: $ref: '#/components/examples/getApiCatalogServiceCiRunsFilterWithSort' Filter by repoOwner: $ref: '#/components/examples/getApiCatalogServiceCiRunsFilterByRepoOwner' Filter by branch: $ref: '#/components/examples/getApiCatalogServiceCiRunsFilterByBranch' Filter by status: $ref: '#/components/examples/getApiCatalogServiceCiRunsFilterByStatus' getApiCatalogSystemEnvironments: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApiCatalogSystemEnvironments' examples: Successful Response: $ref: '#/components/examples/getApiCatalogSystemEnvironmentsSuccessfulResponse' Filter by isProduction: $ref: '#/components/examples/getApiCatalogSystemEnvironmentsFilterByIsProduction' Response with Pagination: $ref: '#/components/examples/getApiCatalogSystemEnvironmentsResponseWithPagination' apiCatalogSystemEnvironment400Error: description: Bad Request content: application/problem+json: schema: anyOf: - $ref: '#/components/schemas/apiCatalogError' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Insufficient Environment Permissions: $ref: '#/components/examples/addApiCatalogSystemEnvironmentAssociations400ErrorInsufficientPermissions' Insufficient Permissions For All Environments: $ref: '#/components/examples/addApiCatalogSystemEnvironmentAssociations400ErrorInsufficientPermissionsAllEnvironments' Invalid DEL Payload: $ref: '#/components/examples/removeApiCatalogSystemEnvironmentAssociations400ErrorInvalidPayload' Invalid PATCH Payload: $ref: '#/components/examples/updateApiCatalogSystemEnvironment400ErrorInvalidPayload' Invalid System Environment ID: $ref: '#/components/examples/apiCatalogSystemEnvironment400ErrorInvalidSystemEnvironmentId' Invalid cursor Value: $ref: '#/components/examples/getApiCatalog400ErrorInvalidCursor' Invalid limit Value: $ref: '#/components/examples/getApiCatalog400ErrorInvalidLimit' Invalid name Value: $ref: '#/components/examples/createApiCatalogSystemEnvironment400ErrorNameRequired' Invalid color Value: $ref: '#/components/examples/createApiCatalogSystemEnvironment400ErrorInvalidColorValue' createApiCatalogSystemEnvironmentResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/createApiCatalogSystemEnvironmentResponse' examples: Successful Response: $ref: '#/components/examples/createApiCatalogSystemEnvironmentSuccessfulResponse' apiCatalogSystemEnvironment409Error: description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Conflicting Name: $ref: '#/components/examples/apiCatalogSystemEnvironment409ErrorConflictingName' getApiCatalogSystemEnvironment: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApiCatalogSystemEnvironment' examples: Successful Response: $ref: '#/components/examples/getApiCatalogSystemEnvironmentSuccessfulResponse' apiCatalogSystemEnvironment404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: System Environment Not Found: $ref: '#/components/examples/apiCatalogSystemEnvironment404ErrorSystemEnvironmentNotFound' updateApiCatalogSystemEnvironmentResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/updateApiCatalogSystemEnvironmentResponse' examples: Successful Response: $ref: '#/components/examples/updateApiCatalogSystemEnvironmentSuccessfulResponse' getApiCatalogSystemEnvironmentAssociations: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApiCatalogSystemEnvironmentAssociations' examples: Successful Response: $ref: '#/components/examples/getApiCatalogSystemEnvironmentAssociationsSuccessfulResponse' Filter by workspaceId: $ref: '#/components/examples/getApiCatalogSystemEnvironmentAssociationsFilterByWorkspaceId' Response with Pagination: $ref: '#/components/examples/getApiCatalogSystemEnvironmentAssociationsResponseWithPagination' addApiCatalogSystemEnvironmentAssociationsResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/addApiCatalogSystemEnvironmentAssociationsResponse' examples: Successful Response: $ref: '#/components/examples/addApiCatalogSystemEnvironmentAssociationsSuccessfulResponse' Response with allowPartial: $ref: '#/components/examples/addApiCatalogSystemEnvironmentAssociationsResponseWithAllowPartial' removeApiCatalogSystemEnvironmentAssociationsResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/removeApiCatalogSystemEnvironmentAssociationsResponse' examples: Successful Response: $ref: '#/components/examples/removeApiCatalogSystemEnvironmentAssociationsSuccessfulResponse' getApis: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApis' examples: Successful Response: $ref: '#/components/examples/getApis' common403Error: description: Forbidden content: application/problem+json: schema: anyOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' examples: Forbidden: $ref: '#/components/examples/common403Error' Inadequate Permissions: $ref: '#/components/examples/common403ErrorPermissions' No Permissions: $ref: '#/components/examples/common403ErrorForbiddenError' No Permissions for Workspace: $ref: '#/components/examples/common403ErrorWorkspaceAccess' Not Authorized: $ref: '#/components/examples/common403ErrorForbiddenNotAuthorized' No Access to Resource: $ref: '#/components/examples/common403ErrorNoAccessToResource' Permission Denied: $ref: '#/components/examples/common403ErrorPermissionDenied' Feature Unavailable: $ref: '#/components/examples/featureUnavailable403Error' api404Error: description: Not Found content: application/problem+json: schema: anyOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail' examples: API Not Found: $ref: '#/components/examples/api404ErrorNotFound' Resource Not Found: $ref: '#/components/examples/api404ErrorInstanceNotFound' API Version Not Found: $ref: '#/components/examples/apiVersion404ErrorNotFound' Collection Not Found: $ref: '#/components/examples/apiCollection404ErrorNotFound' Schema Not Found: $ref: '#/components/examples/apiSchema404ErrorNotFound' v9Unsupported: description: v9 Unsupported content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetail' examples: v9 Unsupported: $ref: '#/components/examples/v9Unsupported' createApi: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/createApiResponse' examples: Successful Response: $ref: '#/components/examples/createApiResponse' workspace400ErrorParamMissing: description: Missing Workspace ID content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetail' examples: Parameter Missing: $ref: '#/components/examples/workspace400ErrorParamMissing' api401Error: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Unauthorized: $ref: '#/components/examples/api401ErrorUnauthorized' api403Error: description: Forbidden content: application/problem+json: schema: anyOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleMessageDetail' examples: Forbidden: $ref: '#/components/examples/api403ErrorForbidden' API Limit Reached: $ref: '#/components/examples/api403ErrorLimitReached' No Access: $ref: '#/components/examples/apiSchema403ErrorForbidden' Feature Unavailable: $ref: '#/components/examples/featureUnavailable403Error' workspace404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetail' examples: Workspace Not Found: $ref: '#/components/examples/workspace404Error' getApi: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApi' examples: Successful Response: $ref: '#/components/examples/getApi' v10HeaderMissing: description: Missing v10 Accept Header content: application/problem+json: schema: $ref: '#/components/schemas/apiErrorNameMessage' examples: Missing v10 Accept Header: $ref: '#/components/examples/v10HeaderMissing' updateApi: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/updateApiResponse' examples: API Updated: $ref: '#/components/examples/updateApiResponse' addApiCollection: description: Created content: application/json: schema: $ref: '#/components/schemas/addApiCollectionResponse' examples: API Collection Created: $ref: '#/components/examples/addApiCollectionResponse' getApiCollection: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApiCollection' examples: Successful Response: $ref: '#/components/examples/getApiCollection' api400Error: description: Bad Request content: application/problem+json: schema: anyOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/apiErrorNameMessage' - $ref: '#/components/schemas/commonErrorNameMessage' examples: Invalid collectionId: $ref: '#/components/examples/apiCollection400InvalidParam' Invalid taskId: $ref: '#/components/examples/apiVersion400ErrorInvalidParam' Version ID Missing: $ref: '#/components/examples/api400ErrorVersionIdMissing' Schema Already Exists: $ref: '#/components/examples/apiSchema400ErrorInvalidParams' Schema Not Linked to API: $ref: '#/components/examples/apiSchema400ErrorNotLinked' API Not Found: $ref: '#/components/examples/apiVersion400ErrorInstanceNotFound' Missing v10 Accept Header: $ref: '#/components/examples/v10HeaderMissing' api422Error: description: Unprocessable Entity content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetail' examples: Unprocessable Entity: $ref: '#/components/examples/apiSchema422ErrorActionNotAllowed' API State Inconsistent: $ref: '#/components/examples/apiVersion422ErrorStateInconsistent' Git-Linked API Errror: $ref: '#/components/examples/gitLinkedApi422Error' commentGet: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/commentResponse' examples: Get Comments: $ref: '#/components/examples/commentGet' comment401Error: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Unauthorized: $ref: '#/components/examples/comment401Error' comment403Error: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Forbidden: $ref: '#/components/examples/comment403Error' comment404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Not Found: $ref: '#/components/examples/comment404Error' comment500Error: description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Internal Server Error: $ref: '#/components/examples/comment500Error' commentCreated: description: Created content: application/json: schema: $ref: '#/components/schemas/commentCreatedUpdated' examples: Comment Created: $ref: '#/components/examples/commentCreated' Tag User in Comment: $ref: '#/components/examples/commentCreatedTagUser' commentUpdated: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/commentCreatedUpdated' examples: Comment Updated: $ref: '#/components/examples/commentUpdated' Tag User in Comment: $ref: '#/components/examples/commentUpdatedTagUser' syncCollectionWithSchema: description: Accepted content: application/json: schema: $ref: '#/components/schemas/syncCollectionWithSchemaResponse' examples: Successful Response: $ref: '#/components/examples/syncCollectionWithSchemaResponse' headers: Location: $ref: '#/components/headers/Location' comment403ErrorAndFeatureUnavailable: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Forbidden: $ref: '#/components/examples/comment403Error' Feature Unavailable: $ref: '#/components/examples/featureUnavailable403Error' createApiSchema: description: Created content: application/json: schema: $ref: '#/components/schemas/createApiSchemaResponse' examples: API Schema Created: $ref: '#/components/examples/createApiSchemaResponse' getApiSchema: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApiSchema' examples: Successful Response: $ref: '#/components/examples/getApiSchema' getApiSchemaFiles: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApiSchemaFiles' examples: Successful Response: $ref: '#/components/examples/getApiSchemaFiles' getApiSchemaFileContents: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApiSchemaFileContents' examples: Successful Response: $ref: '#/components/examples/getApiSchemaFileContents' createUpdateApiSchemaFile: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/createUpdateApiSchemaFileResponse' examples: Successful Response: $ref: '#/components/examples/createUpdateApiSchemaFileResponse' getMigrationStatus: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getMigrationStatus' examples: Successful Response: $ref: '#/components/examples/getMigrationStatusSuccess' Migration Failed: $ref: '#/components/examples/getMigrationStatusFailure' getMigrationStatus400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/getMigrationStatus400Error' examples: Unsupported Definition Type: $ref: '#/components/examples/migrateApiToSpecHub400ErrorMigrationStatusInvalidFormat' migrateApiToSpecHub401Error: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Unauthorized: $ref: '#/components/examples/migrateApiToSpecHub401Error' apiSpec403Error: description: Forbidden content: application/json: schema: anyOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Forbidden: $ref: '#/components/examples/apiSpec403ErrorForbidden' Authentication Error: $ref: '#/components/examples/apiSpecSyncOptions403ErrorAuthenticationError' No Permissions: $ref: '#/components/examples/apiSpec403ErrorNoPermissions' Feature Unavailable: $ref: '#/components/examples/featureUnavailable403Error' migrateApiToSpecHub200Response: description: Empty API Migration content: application/json: schema: $ref: '#/components/schemas/migrateToSpecHubResponse' examples: Empty API Migration: $ref: '#/components/examples/migrateApiToSpecHubResponseEmptyMigration' migrateApiToSpecHub202Response: description: Migration Started Successful content: application/json: schema: $ref: '#/components/schemas/migrateToSpecHubResponse' examples: Successful Response: $ref: '#/components/examples/migrateApiToSpecHubResponse' migrateApiToSpecHub400Error: description: Bad Request content: application/problem+json: schema: anyOf: - $ref: '#/components/schemas/migrateApiToSpecHub400ErrorTitleMessage' - $ref: '#/components/schemas/migrateApiToSpecHub400ErrorTitleMessageDetails' - $ref: '#/components/schemas/migrateApiToSpecHub400ErrorTypeNameMessageTitle' examples: Repo Linked to Another Workspace: $ref: '#/components/examples/migrateApiToSpecHub400ErrorRepoLinkedToAnotherWorkspace' Unsupported Definition Type: $ref: '#/components/examples/migrateApiToSpecHub400ErrorUnsupportedDefinitionType' Invalid path Parameter: $ref: '#/components/examples/migrateApiToSpecHub400ErrorInvalidPathParam' tagGetPut: description: Success Response content: application/json: schema: $ref: '#/components/schemas/tagGetPut' examples: Successful Response: $ref: '#/components/examples/tagGetPut' tag401Error: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Invalid Credentials: $ref: '#/components/examples/tag401Error' Unauthorized: $ref: '#/components/examples/tag401ErrorUnauthorized' apiTags403Error: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Access Denied: $ref: '#/components/examples/tag403Error' Feature Unavailable: $ref: '#/components/examples/featureUnavailable403Error' tag404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Resource Not Found: $ref: '#/components/examples/tag404Error' tag500Error: description: Unexpected Error content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Unexpected Error: $ref: '#/components/examples/tag500Error' apiTag400Error: description: Bad Request content: application/json: schema: anyOf: - $ref: '#/components/schemas/tag400Error' - $ref: '#/components/schemas/apiErrorNameMessage' examples: Bad Request: $ref: '#/components/examples/tag400Error' Missing v10 Accept Header: $ref: '#/components/examples/v10HeaderMissing' getStatusOfAnAsyncApiTask: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getStatusOfAnAsyncApiTask' examples: Successful Response: $ref: '#/components/examples/getStatusOfAnAsyncApiTask' taskNotFound: description: Task Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetail' examples: Task Not Found: $ref: '#/components/examples/taskNotFound' getApiVersions: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApiVersions' examples: Successful Response: $ref: '#/components/examples/getApiVersions' createApiVersion: description: Accepted content: application/json: schema: $ref: '#/components/schemas/createApiVersionResponse' examples: API Version Created: $ref: '#/components/examples/createApiVersionResponse' headers: Location: $ref: '#/components/headers/Location' getApiVersion: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApiVersion' examples: Successful Response: $ref: '#/components/examples/getApiVersion' apiVersion302StatusPending: description: Version in Pending Status content: application/json: schema: {} example: {} headers: Location: $ref: '#/components/headers/Location' updateApiVersion: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/updateApiVersionResponse' examples: API Version Updated: $ref: '#/components/examples/updateApiVersionResponse' getAuditLogs: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getAuditLogs' examples: Successful Response: $ref: '#/components/examples/getAuditLogsSuccessfulResponse' Filter Response by User ID: $ref: '#/components/examples/getAuditLogsFilterResponseByUserID' Filter Response by Audit Action: $ref: '#/components/examples/getAuditLogsFilterResponseByAuditAction' Filter Response by Order: $ref: '#/components/examples/getAuditLogsFilterResponseByOrder' auditLogs400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorNameMessage' examples: Invalid Audit Action: $ref: '#/components/examples/auditLogs400ErrorInvalidAuditAction' common429Error: description: Too Many Requests content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Too Many Requests: $ref: '#/components/examples/rateLimit429ErrorTooManyRequests' Rate Limit Exceeded: $ref: '#/components/examples/common429ErrorRateLimitExceeded' getAuditLogEventActions: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getAuditLogEventActions' examples: Successful Response: $ref: '#/components/examples/getAuditLogEventActions' auditLogs403Error: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorNameMessage' examples: Forbidden: $ref: '#/components/examples/auditLogs403ErrorForbidden' getCollectionAccessKeys: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getCollectionAccessKeys' examples: Successful Response: $ref: '#/components/examples/getCollectionAccessKeys' common400Error: description: Bad Request content: application/problem+json: schema: anyOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: Bad Request: $ref: '#/components/examples/common400ErrorResponse' Invalid Request: $ref: '#/components/examples/common400Error' Request Body Missing: $ref: '#/components/examples/common400ErrorRequestBodyMissing' Invalid Cursor: $ref: '#/components/examples/common400ErrorInvalidCursor' Missing name Parameter: $ref: '#/components/examples/paramMissing400ErrorName' Missing collection Parameter: $ref: '#/components/examples/paramMissing400ErrorCollection' Missing serverResponse Parameter: $ref: '#/components/examples/paramMissing400ErrorServerResponse' Missing statusCode Parameter: $ref: '#/components/examples/paramMissing400ErrorResponseStatusCode' cakNotFound404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Key Not Found: $ref: '#/components/examples/cakNotFound404Error' asyncMergeCollectionFork: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/asyncMergeCollectionFork' examples: Successful Response: $ref: '#/components/examples/asyncMergePullCollectionForkSuccessfulResponse' collectionForks400ErrorMalformedRequest: description: Malformed Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Malformed Request: $ref: '#/components/examples/collectionForks400ErrorMalformedRequest' collectionForks403ErrorForbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Forbidden: $ref: '#/components/examples/collectionForks403ErrorForbidden' Insufficient Permissions: $ref: '#/components/examples/common403ErrorNotEnoughPermissions' asyncMergePullCollectionTaskStatus: description: Task Status Response content: application/json: schema: $ref: '#/components/schemas/asyncMergePullCollectionTaskStatus' examples: Success: $ref: '#/components/examples/asyncMergePullCollectionTaskStatusSuccess' In Progress: $ref: '#/components/examples/asyncMergePullCollectionTaskStatusInProgress' Failed: $ref: '#/components/examples/asyncMergePullCollectionTaskStatusFailed' collectionForks404ErrorTaskNotFound: description: Task Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Task Not Found: $ref: '#/components/examples/collectionForks404ErrorTaskNotFound' getCollections: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getCollections' examples: Successful Response: $ref: '#/components/examples/getCollectionsSuccessfulResponse' Filter by name: $ref: '#/components/examples/getCollectionsFilterByName' Filter by Workspace: $ref: '#/components/examples/getCollectionsFilterByWorkspace' Invalid Workspace: $ref: '#/components/examples/getCollectionsInvalidWorkspace' createCollection: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/collectionCreated' examples: Create Collection: $ref: '#/components/examples/createCollectionCreateCollection' collection400ErrorInstanceFound: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: Bad Request: $ref: '#/components/examples/collection400ErrorInstanceFoundBadRequest' getCollectionsForkedByUser: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getCollectionsForkedByUser' examples: Successful Response: $ref: '#/components/examples/getCollectionsForkedByUserSuccessfulResponse' Response with cursor: $ref: '#/components/examples/getCollectionsForkedByUserResponseWithCursor' Response with direction: $ref: '#/components/examples/getCollectionsForkedByUserResponseWithDirection' Response with limit: $ref: '#/components/examples/getCollectionsForkedByUserResponseWithLimit' fork400ErrorNoUserFound: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/fork400ErrorNoUserFound' examples: User Not Found: $ref: '#/components/examples/fork400ErrorNoUserFound' createCollectionFork: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/createCollectionForkResponse' examples: Successful Response: $ref: '#/components/examples/createCollectionForkSuccessfulResponse' instanceNotFoundCollection: description: Instance Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: Instance Not Found: $ref: '#/components/examples/instanceNotFoundCollectionNotFound' Fork Not Found: $ref: '#/components/examples/pullCollectionChangesNotFound' mergeCollectionFork: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/mergeCollectionForkResponse' examples: Collection Fork Merged: $ref: '#/components/examples/mergeCollectionForkResponse' getCollection: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getCollection' examples: Successful Response: $ref: '#/components/examples/getCollectionSuccessfulResponse' Forked Collection Response: $ref: '#/components/examples/getCollectionForkedCollectionResponse' Response with model=minimal: $ref: '#/components/examples/getCollectionResponseWithModelMinimal' Get Collection with Access Key: $ref: '#/components/examples/getCollectionGetCollectionWithAccessKey' collection400ErrorCollectionNotFound: description: Collection Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorNameMessage' examples: Not Found: $ref: '#/components/examples/collection400ErrorCollectionNotFound' putCollection: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/putCollectionResponse' examples: Replace a Basic Collection's Data: $ref: '#/components/examples/putCollectionReplaceABasicCollectionSData' Replace a Detailed Collection's Data: $ref: '#/components/examples/putCollectionReplaceADetailedCollectionSData' Copy Another Collection's Contents: $ref: '#/components/examples/putCollectionCopyAnotherCollectionSContents' Disable a Request's Query Params: $ref: '#/components/examples/putCollectionDisableARequestSQueryParams' putCollectionAsync: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/putCollectionResponseAsync' examples: Update In Progress: $ref: '#/components/examples/putCollectionAsyncUpdateInProgress' collectionPut400Errors: description: Bad Request content: application/problem+json: schema: anyOf: - $ref: '#/components/schemas/commonErrorNameMessage' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: Malformed Request: $ref: '#/components/examples/collectionPut400ErrorsMalformedRequest' Collection ID Mismatch: $ref: '#/components/examples/collectionPut400ErrorsCollectionIDMismatch' Invalid Schema: $ref: '#/components/examples/collectionPut400ErrorsInvalidSchema' Missing collection Property: $ref: '#/components/examples/collectionPut400ErrorsMissingCollectionProperty' Missing info Property: $ref: '#/components/examples/collectionPut400ErrorsMissingInfoProperty' collectionPut404Errors: description: Not Found content: application/problem+json: schema: anyOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: instanceNotFoundError: $ref: '#/components/examples/collectionPut404ErrorsInstanceNotFoundError' Not found: $ref: '#/components/examples/collectionPut404ErrorsNotFound' collectionPut409Errors: description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Operation in Progress: $ref: '#/components/examples/collectionPut409ErrorsOperationInProgress' deleteCollection: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/deleteCollection' examples: Successful Response: $ref: '#/components/examples/deleteCollectionSuccessfulResponse' patchCollection: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/patchCollectionResponse' examples: Update Info: $ref: '#/components/examples/patchCollectionUpdateInfo' Update Variables: $ref: '#/components/examples/patchCollectionUpdateVariables' Update Events: $ref: '#/components/examples/patchCollectionUpdateEvents' Update Auth: $ref: '#/components/examples/patchCollectionUpdateAuth' collectionPatch400Errors: description: Bad Request content: application/json: schema: anyOf: - $ref: '#/components/schemas/commonErrorNameMessage' - $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: Invalid auth Type: $ref: '#/components/examples/collectionPatch400ErrorsInvalidAuthType' Invalid variable Parameter: $ref: '#/components/examples/collectionPatch400ErrorsInvalidVariableParameter' Invalid events Parameter: $ref: '#/components/examples/collectionPatch400ErrorsInvalidEventsParameter' Invalid events id Parameter: $ref: '#/components/examples/collectionPatch400ErrorsInvalidEventsIdParameter' Missing variable Parameter: $ref: '#/components/examples/collectionPatch400ErrorsMissingVariableParameter' Missing info Parameter: $ref: '#/components/examples/collectionPatch400ErrorsMissingInfoParameter' Missing events Parameter: $ref: '#/components/examples/collectionPatch400ErrorsMissingEventsParameter' Missing auth Parameter: $ref: '#/components/examples/collectionPatch400ErrorsMissingAuthParameter' duplicateCollection: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/duplicateCollectionResponse' examples: Successful Response: $ref: '#/components/examples/duplicateCollectionSuccessfulResponse' createCollectionFolder: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/createCollectionFolderResponse' examples: Create a Folder: $ref: '#/components/examples/createCollectionFolderCreateAFolder' Create a Child Folder: $ref: '#/components/examples/createCollectionFolderCreateAChildFolder' Create a Folder with Requests and Responses: $ref: '#/components/examples/createCollectionFolderCreateAFolderWithRequestsAndResponses' collectionFolder400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: Bad Request: $ref: '#/components/examples/collectionFolder400ErrorBadRequest' Change Parent Error: $ref: '#/components/examples/collectionFolder400ErrorChangeParentError' Order Update Error: $ref: '#/components/examples/collectionFolder400ErrorOrderUpdateError' collectionFolder401Error: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: Unauthorized: $ref: '#/components/examples/collectionFolder401ErrorUnauthorized' getCollectionForks: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getCollectionForks' examples: Successful Response: $ref: '#/components/examples/getCollectionForksSuccessfulResponse' Response with cursor: $ref: '#/components/examples/getCollectionForksResponseWithCursor' Response with direction: $ref: '#/components/examples/getCollectionForksResponseWithDirection' Response with limit: $ref: '#/components/examples/getCollectionForksResponseWithLimit' forkCollection400ErrorNoForks: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorNameMessage' examples: No Forks for Collection ID: $ref: '#/components/examples/forkCollection400ErrorNoForks' Bad Request: $ref: '#/components/examples/getCollectionForksBadRequest' fork404Error: description: Not Found content: application/json: schema: $ref: '#/components/schemas/fork404Error' examples: Fork Not Found: $ref: '#/components/examples/fork404Error' getGeneratedCollectionSpecs: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getGeneratedCollectionSpecs' examples: Successful Response: $ref: '#/components/examples/getGeneratedCollectionSpecs' apiSpec404Error: description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Instance Not Found: $ref: '#/components/examples/apiSpec404ErrorInstanceNotFound' Resource Not Found: $ref: '#/components/examples/apiSpec404ErrorResourceNotFound' Specification Not Found: $ref: '#/components/examples/apiSpec404ErrorSpecificationNotFound' Version Tag Not Found: $ref: '#/components/examples/apiSpec404ErrorVersionTagNotFound' generateTaskResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/generateTaskResponse' examples: Generate Spec Task: $ref: '#/components/examples/generateSpecTaskResponse' Generate Collection Task: $ref: '#/components/examples/generateCollectionTaskResponse' apiSpec423ErrorLocked: description: Locked content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Generation in Progress: $ref: '#/components/examples/apiSpec423ErrorLocked' publishDocumentationResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/publishDocumentationResponse' examples: Successful Response: $ref: '#/components/examples/publishDocumentationSuccessfulResponse' documentation400ErrorBadRequest: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Bad Request: $ref: '#/components/examples/documentation400ErrorBadRequest' Invalid customColor Value: $ref: '#/components/examples/documentation400ErrorInvalidCustomColor' Missing customColor Property: $ref: '#/components/examples/documentation400ErrorCustomColorMissing' Missing customization Property: $ref: '#/components/examples/documentation400ErrorCustomizationMissing' documentation401ErrorUnauthorized: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Unauthorized: $ref: '#/components/examples/common401Error' documentation403ErrorForbidden: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Forbidden: $ref: '#/components/examples/common403Error' Feature Unavailable: $ref: '#/components/examples/featureUnavailable403Error' documentation500ErrorServerError: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Unauthorized: $ref: '#/components/examples/common500Error' documentation404ErrorNotFound: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Not Found: $ref: '#/components/examples/documentation404ErrorNotFound' pullCollectionChanges: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/pullCollectionChangesResponse' examples: Successful Response: $ref: '#/components/examples/pullCollectionChangesSuccessfulResponse' forkCollection400ErrorBadId: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorNameMessage' examples: Bad Request: $ref: '#/components/examples/forkCollection400ErrorBadId' Not a Forked Collection: $ref: '#/components/examples/pullCollectionChangesBadRequest' getCollectionPullRequests: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getCollectionPullRequests' examples: Successful Response: $ref: '#/components/examples/getCollectionPullRequestsSuccessfulResponse' pullRequest403Error: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: No Permissions: $ref: '#/components/examples/common403ErrorNotEnoughPermissions' Missing Viewer Role: $ref: '#/components/examples/pullRequest403ErrorRolePermissionsCollection' Reviewers Missing Viewer Role: $ref: '#/components/examples/pullRequest403ErrorNoViewerAccessCollections' Feature Unavailable: $ref: '#/components/examples/featureUnavailable403Error' pullRequestCreated: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/pullRequestCreated' example: id: 4e1a6609-1a29-4037-a411-89ecc14c6cd8 title: Test PR status: open sourceId: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef createdAt: '2024-02-20T09:55:46.000Z' createdBy: '12345678' updatedAt: '2024-02-20T09:58:57.000Z' description: This is a test pull request. destinationId: 12345678-ec548788-unftw-rgn8-83b8-0b59798648e4 pullRequest400Error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Action Not Allowed: $ref: '#/components/examples/pullRequestReview400ErrorActionNotAllowed' Duplicate Pull Request: $ref: '#/components/examples/pullRequest400ErrorDuplicate' Invalid Action: $ref: '#/components/examples/pullRequestReview400ErrorInvalidAction' Invalid Fork Source: $ref: '#/components/examples/forkCollection400ErrorBadForkRelation' Pull Request Already Exists: $ref: '#/components/examples/pullRequest400ErrorDuplicate' createCollectionRequest: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/createCollectionRequestResponse' examples: GET Request: $ref: '#/components/examples/createCollectionRequestGETRequest' POST Request: $ref: '#/components/examples/createCollectionRequestPOSTRequest' Request in a Folder: $ref: '#/components/examples/createCollectionRequestRequestInAFolder' Request with Auth: $ref: '#/components/examples/createCollectionRequestRequestWithAuth' Request with Tests: $ref: '#/components/examples/createCollectionRequestRequestWithTests' collectionRequest400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: Bad Request: $ref: '#/components/examples/collectionRequest400ErrorBadRequest' Change Parent Error: $ref: '#/components/examples/collectionRequest400ErrorChangeParentError' collectionRequest401Error: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: Unauthorized: $ref: '#/components/examples/collectionRequest401ErrorUnauthorized' createCollectionResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/createCollectionResponseResponse' examples: GET Response: $ref: '#/components/examples/createCollectionResponseGETResponse' POST Response: $ref: '#/components/examples/createCollectionResponsePOSTResponse' collectionResponse400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: Bad Request: $ref: '#/components/examples/collectionResponse400ErrorBadRequest' Change Parent Error: $ref: '#/components/examples/collectionResponse400ErrorChangeParentError' collectionResponse401Error: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: Unauthorized: $ref: '#/components/examples/collectionResponse401ErrorUnauthorized' getCollectionRoles: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getCollectionRoles' examples: Successful Response: $ref: '#/components/examples/getCollectionRolesSuccessfulResponse' collection404ErrorInstanceNotFound: description: Instance Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitle' examples: Instance Not Found: $ref: '#/components/examples/collection404ErrorInstanceNotFound' collectionRoles400ErrorMissingProperty: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Missing Property: $ref: '#/components/examples/collectionRoles400ErrorMissingProperty' getSourceCollectionStatus: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getSourceCollectionStatus' examples: Successful Response: $ref: '#/components/examples/getSourceCollectionStatusSuccessfulResponse' forkCollection400ErrorNotForked: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/forkCollection400Error' examples: Collection Not Forked: $ref: '#/components/examples/forkCollection400ErrorNotForked' Bad Request: $ref: '#/components/examples/pullCollectionChangesBadRequest' getCollectionFolder: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getCollectionFolder' examples: Successful Response: $ref: '#/components/examples/getCollectionFolderSuccessfulResponse' Response with populate Parameter: $ref: '#/components/examples/getCollectionFolderResponseWithPopulateParameter' Response with ids Parameter: $ref: '#/components/examples/getCollectionFolderResponseWithIdsParameter' Response with uid Parameter: $ref: '#/components/examples/getCollectionFolderResponseWithUidParameter' collectionFolder404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: Not Found: $ref: '#/components/examples/collectionFolder404ErrorNotFound' updateCollectionFolder: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/updateCollectionFolderResponse' examples: Successful Response: $ref: '#/components/examples/updateCollectionFolderSuccessfulResponse' Sort Requests in Folder: $ref: '#/components/examples/updateCollectionFolderSortRequestsInFolder' Sort Folders in Folder: $ref: '#/components/examples/updateCollectionFolderSortFoldersInFolder' deleteCollectionFolder: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/deleteCollectionFolder' examples: Successful Response: $ref: '#/components/examples/deleteCollectionFolderSuccessfulResponse' getCollectionRequest: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getCollectionRequest' examples: GET Request: $ref: '#/components/examples/getCollectionRequestGETRequest' POST Request: $ref: '#/components/examples/getCollectionRequestPOSTRequest' Request with Inherit Parent Auth: $ref: '#/components/examples/getCollectionRequestRequestWithInheritParentAuth' Response with populate Parameter: $ref: '#/components/examples/getCollectionRequestResponseWithPopulateParameter' Response with ids Parameter: $ref: '#/components/examples/getCollectionRequestResponseWithIdsParameter' Response with uid Parameter: $ref: '#/components/examples/getCollectionRequestResponseWithUidParameter' collectionRequest404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: instanceFoundError: $ref: '#/components/examples/collectionRequest404ErrorInstanceFoundError' instanceNotFoundError: $ref: '#/components/examples/collectionRequest404ErrorInstanceNotFoundError' updateCollectionRequest: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/updateCollectionRequestResponse' examples: Successful Response: $ref: '#/components/examples/updateCollectionRequestSuccessfulResponse' Update to Inherit Parent Auth: $ref: '#/components/examples/updateCollectionRequestUpdateToInheritParentAuth' Disable Query Params: $ref: '#/components/examples/updateCollectionRequestDisableQueryParams' deleteCollectionRequest: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/deleteCollectionRequest' examples: Successful Response: $ref: '#/components/examples/deleteCollectionRequestSuccessfulResponse' getCollectionResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getCollectionResponse' examples: GET Response: $ref: '#/components/examples/getCollectionResponseGETResponse' POST Response: $ref: '#/components/examples/getCollectionResponsePOSTResponse' Response with populate Parameter: $ref: '#/components/examples/getCollectionResponseResponseWithPopulateParameter' Response with ids Parameter: $ref: '#/components/examples/getCollectionResponseResponseWithIdsParameter' Response with uid Parameter: $ref: '#/components/examples/getCollectionResponseResponseWithUidParameter' collectionResponse404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: Not Found: $ref: '#/components/examples/collectionResponse404ErrorNotFound' Unauthorized: $ref: '#/components/examples/collectionResponse404ErrorUnauthorized' updateCollectionResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/updateCollectionResponseResponse' examples: Successful Response: $ref: '#/components/examples/updateCollectionResponseSuccessfulResponse' deleteCollectionResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/deleteCollectionResponse' examples: Successful Response: $ref: '#/components/examples/deleteCollectionResponseSuccessfulResponse' tag403Error: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Not Enterprise: $ref: '#/components/examples/tag403Error' No Developer Role: $ref: '#/components/examples/tag403ErrorNoDeveloperRole' No View Permissions: $ref: '#/components/examples/tag403ErrorNoViewPermissions' Feature Unavailable: $ref: '#/components/examples/featureUnavailable403Error' tag400Error: description: Bad Request content: application/problem+json: schema: anyOf: - $ref: '#/components/schemas/tag400Error' - $ref: '#/components/schemas/tagElement400Error' examples: Tag Exceeds Max Size: $ref: '#/components/examples/tag400Error' Exceeds Max Number of Tags: $ref: '#/components/examples/tag400ErrorExceedsMaxNumberOfTags' Invalid Slug Pattern: $ref: '#/components/examples/tag400ErrorInvalidSlugPattern' Missing tags Object: $ref: '#/components/examples/tag400ErrorMissingTagsObject' transformCollectionToOpenAPI: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/transformCollectionToOpenAPI' examples: Successful JSON Response: $ref: '#/components/examples/transformCollectionToOpenAPISuccessfulJSONResponse' Successful YAML Response: $ref: '#/components/examples/transformCollectionToOpenAPISuccessfulYAMLResponse' collectionToApi401Error: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Unauthorized: $ref: '#/components/examples/collectionToApi401Error' collectionToApi404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Not Found: $ref: '#/components/examples/collectionToApi404Error' collectionToApi500Error: description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Internal Server Error: $ref: '#/components/examples/collectionToApi500Error' transferCollectionItemsResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/transferCollectionItemsResponse' examples: Copy Folder to Collection: $ref: '#/components/examples/transferCollectionFoldersCopyFolderToCollection' Move Folder to a Collection: $ref: '#/components/examples/transferCollectionFoldersMoveFolderToACollection' Move Folder Before Another Folder: $ref: '#/components/examples/transferCollectionFoldersMoveFolderBeforeAnotherFolder' Copy Request to Collection: $ref: '#/components/examples/transferCollectionRequestsCopyRequestToCollection' Move Request to Top of Folder: $ref: '#/components/examples/transferCollectionRequestsMoveRequestToTopOfFolder' Move Request After Another Request: $ref: '#/components/examples/transferCollectionRequestsMoveRequestAfterAnotherRequest' Copy Response to Request: $ref: '#/components/examples/transferCollectionResponsesCopyResponseToRequest' Move Response to Request: $ref: '#/components/examples/transferCollectionResponsesMoveResponseToRequest' Move Response Before Another Response: $ref: '#/components/examples/transferCollectionResponsesMoveResponseBeforeAnotherResponse' transferCollectionItems400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetail' examples: One or more folder ids provided were not found: $ref: '#/components/examples/transferCollectionItems400ErrorOneOrMoreFolderIdsProvidedWereNotFound' One or more request ids provided were not found: $ref: '#/components/examples/transferCollectionItems400ErrorOneOrMoreRequestIdsProvidedWereNotFound' Target Folder Not Found: $ref: '#/components/examples/transferCollectionItems400ErrorTargetFolderNotFound' Invalid target Type: $ref: '#/components/examples/transferCollectionItems400ErrorInvalidTargetType' getDuplicateCollectionTaskStatus: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/duplicateCollectionResponse' examples: Task Completed: $ref: '#/components/examples/getDuplicateCollectionTaskStatusTaskCompleted' Task Processing: $ref: '#/components/examples/getDuplicateCollectionTaskStatusTaskProcessing' Task Failed: $ref: '#/components/examples/getDuplicateCollectionTaskStatusTaskFailed' duplicationTask400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Invalid Task ID: $ref: '#/components/examples/duplicationTask400ErrorInvalidId' common404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Not Found: $ref: '#/components/examples/common404Error' Resource Not Found: $ref: '#/components/examples/common404ErrorResourceNotFound' Resource Does Not Exist: $ref: '#/components/examples/common404ErrorResourceDoesNotExist' getCollectionUpdatesTasks: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getCollectionUpdatesTasks' examples: Success: $ref: '#/components/examples/getCollectionUpdatesTasksSuccess' Sync Failed: $ref: '#/components/examples/getCollectionUpdatesTasksSyncFailed' Sync In Progress: $ref: '#/components/examples/getCollectionUpdatesTasksSyncInProgress' getAllComponents: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getAllComponents' examples: Successful Response: $ref: '#/components/examples/getAllComponents' Filter Results by include: $ref: '#/components/examples/getAllComponentsIncludeFilter' Filter Results by include and expand: $ref: '#/components/examples/getAllComponentsIncludeExpandFilters' componentLibrary400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Invalid Parameters: $ref: '#/components/examples/componentLibrary400ErrorInvalidParameters' createComponentResponse: description: Component Created content: application/json: schema: $ref: '#/components/schemas/createComponentResponse' examples: Component Created: $ref: '#/components/examples/createComponentResponse' componentLibrary409Error: description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Cannot Publish Version: $ref: '#/components/examples/componentLibrary409ErrorCannotPublishVersionConflict' Cannot Rename Component: $ref: '#/components/examples/componentLibrary409ErrorComponentCannotRenameArchivedConflict' Duplicate Label: $ref: '#/components/examples/componentLibrary409ErrorDuplicateLabel' Duplicate Version Label: $ref: '#/components/examples/componentLibrary409ErrorDuplicateVersionLabel' Draft Archived: $ref: '#/components/examples/componentLibrary409ErrorDraftArchivedConflict' getComponent: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getComponent' examples: Successful Response: $ref: '#/components/examples/getComponent' componentLibrary404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Entity Not Found: $ref: '#/components/examples/common404ErrorEntityNotFound' Component Version Not Found: $ref: '#/components/examples/componentLibrary404ErrorComponentVersionNotFound' updateComponentResponse: description: Component Updated content: application/json: schema: $ref: '#/components/schemas/updateComponentResponse' examples: Component Updated: $ref: '#/components/examples/updateComponentResponse' getComponentDraft: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getComponentDraft' examples: Successful Response: $ref: '#/components/examples/getComponentDraft' updateComponentDraftResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/updateComponentDraftResponse' examples: Component Draft Updated: $ref: '#/components/examples/updateComponentDraftResponse' getComponentVersions: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getComponentVersions' examples: Successful Response: $ref: '#/components/examples/getComponentVersions' createComponentVersionResponse: description: Version Created content: application/json: schema: $ref: '#/components/schemas/createComponentVersionResponse' examples: Successful Response: $ref: '#/components/examples/createComponentVersionResponse' getComponentVersion: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/componentVersionData' examples: Successful Response: $ref: '#/components/examples/getComponentVersion' submitContextGraphAsk: description: Accepted content: application/json: schema: $ref: '#/components/schemas/submitContextGraphAskResponse' examples: Accepted: $ref: '#/components/examples/submitContextGraphAskResponse' contextGraph400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Query Too Short: $ref: '#/components/examples/contextGraph400ErrorQueryTooShort' contextGraph403Error: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: No Access to Context Graph: $ref: '#/components/examples/contextGraph403ErrorNoAccess' contextGraph429Error: description: Too Many Requests content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Quota Exceeded: $ref: '#/components/examples/contextGraph429ErrorQuotaExceeded' getContextGraphAsk: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getContextGraphAskResponse' examples: Completed Ask: $ref: '#/components/examples/getContextGraphAskResponseCompleted' Running Ask: $ref: '#/components/examples/getContextGraphAskResponseRunning' contextGraphAsk404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Ask Not Found: $ref: '#/components/examples/contextGraph404ErrorAskNotFound' getAllCustomFunctions: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/customFunctionList' examples: Successful Response: $ref: '#/components/examples/getAllCustomFunctions' createCustomFunction: description: Custom Function Created content: application/json: schema: $ref: '#/components/schemas/writeResult' examples: Custom Function Created: $ref: '#/components/examples/createCustomFunctionResponse' customFunction409Conflict: description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Custom Function Path Conflict: $ref: '#/components/examples/apiGovernance409ErrorCustomFunctionPathConflict' getCustomFunction: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/customFunction' examples: Successful Response: $ref: '#/components/examples/getCustomFunction' With Content: $ref: '#/components/examples/getCustomFunctionWithContent' updateCustomFunction: description: Custom Function Updated content: application/json: schema: $ref: '#/components/schemas/writeResult' examples: Custom Function Updated: $ref: '#/components/examples/updateCustomFunctionResponse' detectedSecretsQueries: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/detectedSecretsQueries' examples: Successful Response: $ref: '#/components/examples/detectedSecretsQueryResponse' With include Query Parameter: $ref: '#/components/examples/detectedSecretsQueryIncludeParam' Filter by Resource Type: $ref: '#/components/examples/detectedSecretsQueryFilterByResource' detectedSecretsQuery400Errors: description: Bad Request content: application/json: schema: anyOf: - $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Bad Request: $ref: '#/components/examples/secretScanner400Error' Invalid Filter: $ref: '#/components/examples/detectedSecrets400FilterError' Invalid Resources: $ref: '#/components/examples/detectedSecrets400InvalidResourcesError' secretScanner401Error: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance' examples: Unauthorized: $ref: '#/components/examples/secretScanner401Error' secretScanner403Error: description: Forbidden content: application/json: schema: anyOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance' examples: Forbidden: $ref: '#/components/examples/common403Error' Feature Unavailable: $ref: '#/components/examples/featureUnavailable403Error' No Role Permissions: $ref: '#/components/examples/secretScanner403ErrorNoPermission' Missing Advanced Security Administration Add-On: $ref: '#/components/examples/secretScanner403ErrorAdvSecAdminMissing' secretScanner500Error: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance' examples: Internal Server Error: $ref: '#/components/examples/secretScanner500Error' updateSecretResolutions: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/updateSecretResolutions' examples: Successful Response: $ref: '#/components/examples/updateSecretResolutionsResponse' secretScanner400InvalidResolutionError: description: Invalid Resolution Type content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance' examples: Invalid Resolution Type: $ref: '#/components/examples/secretScanner400InvalidResolutionError' getSecretsLocations: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getSecretsLocations' examples: Successful Response: $ref: '#/components/examples/getSecretsLocations' secretScanner400Error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance' examples: Invalid Limit: $ref: '#/components/examples/secretScanner400Error' Invalid resourceType Filter: $ref: '#/components/examples/secretScanner400InvalidResourceTypeError' getAsyncCollectionTaskStatus: description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/getAsyncTaskStatus' - $ref: '#/components/schemas/getAsyncTaskStatusFailed' examples: Pending Status: $ref: '#/components/examples/getAsyncCollectionTaskStatusPending' Completed Status: $ref: '#/components/examples/getAsyncCollectionTaskStatus' Failed Status: $ref: '#/components/examples/getAsyncCollectionTaskStatusFailure' apiSpec401Error: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Unauthorized: $ref: '#/components/examples/common401Error' getEnvironments: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getEnvironments' examples: Successful Response: $ref: '#/components/examples/getEnvironments' Filter by Workspace: $ref: '#/components/examples/getEnvironmentsFilterByWorkspace' Invalid Workspace: $ref: '#/components/examples/environment200invalidWorkspace' environments404Error: description: Not Found content: application/problem+json: schema: anyOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' - $ref: '#/components/schemas/commonErrorNameMessage' examples: Environment Does Not Exist: $ref: '#/components/examples/environments404ErrorEnvDoesNotExist' Instance Not Found: $ref: '#/components/examples/environments404ErrorInstanceNotFound' Not Found: $ref: '#/components/examples/environments404ErrorNotFound' createEnvironment: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/createEnvironmentResponse' examples: Successful Response: $ref: '#/components/examples/createEnvironmentResponse' environment400Errors: description: Bad Request content: application/problem+json: schema: anyOf: - $ref: '#/components/schemas/commonErrorNameMessageDetails' - $ref: '#/components/schemas/commonErrorNameMessage' examples: Invalid Type: $ref: '#/components/examples/environments400ErrorInvalidType' Malformed Request: $ref: '#/components/examples/environments400ErrorMalformedRequest' common411Error: description: Length Required content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Length Required: $ref: '#/components/examples/common411Error' common413Error: description: Payload Too Large content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Payload Too Large: $ref: '#/components/examples/common413Error' getEnvironment: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getEnvironment' examples: Successful Response: $ref: '#/components/examples/getEnvironment' putEnvironment: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/putEnvironmentResponse' examples: Successful Response: $ref: '#/components/examples/putEnvironmentResponse' deleteEnvironment: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/deleteEnvironment' examples: Successful Response: $ref: '#/components/examples/deleteEnvironment' patchEnvironment: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/patchEnvironmentResponse' examples: Update Environment Name: $ref: '#/components/examples/patchEnvironment' Add Variable: $ref: '#/components/examples/patchEnvironmentAddVariableResponse' Add Description to Existing Variable: $ref: '#/components/examples/patchEnvironmentAddDescriptionResponse' Enable Variable: $ref: '#/components/examples/patchEnvironmentEnableVariableResponse' Update Variable: $ref: '#/components/examples/patchEnvironmentUpdateVariableResponse' Add Secret Variable: $ref: '#/components/examples/patchEnvironmentAddSecretVariableResponse' Unshare Variable: $ref: '#/components/examples/patchEnvironmentUnshareVariableResponse' Remove Variable: $ref: '#/components/examples/patchEnvironmentRemoveVariableResponse' Remove Multiple Variables: $ref: '#/components/examples/patchEnvironmentRemoveMultipleVariablesResponse' Remove and Add Variable: $ref: '#/components/examples/patchEnvironmentRemoveAndAddVariableResponse' patchEnvironment400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/patchEnvironment400Error' examples: Invalid PATCH Body: $ref: '#/components/examples/patchEnvironment400ErrorInvalidPatchBody' Empty value Property: $ref: '#/components/examples/patchEnvironment400ErrorEmptyValue' Invalid Environment ID: $ref: '#/components/examples/environments400ErrorInvalidId' Invalid value Type: $ref: '#/components/examples/patchEnvironment400ErrorInvalidValue' Invalid path: $ref: '#/components/examples/patchEnvironment400ErrorInvalidPath' path Doesn't Exist: $ref: '#/components/examples/patchEnvironment400ErrorPath' environments403Error: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Forbidden: $ref: '#/components/examples/environments403ErrorForbidden' getEnvironmentForks: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getEnvironmentForks' examples: Successful Response: $ref: '#/components/examples/getEnvironmentForks' environmentForks400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetail' examples: Environment Not Forked: $ref: '#/components/examples/environmentForks400ErrorNotForked' environmentForks404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Environment Not Found: $ref: '#/components/examples/environmentForks404Error' forkEnvironment: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/forkEnvironmentResponse' examples: Successful Response: $ref: '#/components/examples/forkEnvironmentResponse' mergeEnvironmentFork: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/mergeEnvironmentForkResponse' examples: Successful Response: $ref: '#/components/examples/mergeEnvironmentForkResponse' pullEnvironment: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/pullEnvironmentResponse' examples: Successful Response: $ref: '#/components/examples/pullEnvironmentResponse' getAllGovernanceGroups: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/governanceGroupList' examples: Successful Response: $ref: '#/components/examples/getAllGovernanceGroups' createGovernanceGroup: description: Governance Group Created content: application/json: schema: $ref: '#/components/schemas/writeResult' examples: Governance Group Created: $ref: '#/components/examples/createGovernanceGroupResponse' governanceGroup409Conflict: description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Governance Group Name Conflict: $ref: '#/components/examples/apiGovernance409ErrorGovernanceGroupNameConflict' updateGovernanceGroup: description: Governance Group Updated content: application/json: schema: $ref: '#/components/schemas/writeResult' examples: Governance Group Updated: $ref: '#/components/examples/updateGovernanceGroupResponse' getGovernanceGroupAssignments: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/rulesetAssignmentList' examples: Successful Response: $ref: '#/components/examples/getGovernanceGroupAssignments' getGovernanceGroupWorkspaces: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/workspaceAssignmentList' examples: Successful Response: $ref: '#/components/examples/getGovernanceGroupWorkspaces' updateGovernanceGroupWorkspaces: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/emptyObject' examples: Workspaces Updated: $ref: '#/components/examples/updateGovernanceGroupWorkspacesResponse' workspaceAssignment409Conflict: description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Workspace Assignment Conflict: $ref: '#/components/examples/apiGovernance409ErrorWorkspaceAssignmentConflict' getGroups: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getGroups' examples: Successful Response: $ref: '#/components/examples/getGroups' getGroup: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getGroup' examples: Successful Response: $ref: '#/components/examples/getGroup' importOpenApiDefinition: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/importOpenApiDefinition' examples: Successful Response: $ref: '#/components/examples/importOpenApiDefinition' import400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/import400Error' examples: Invalid Parameters: $ref: '#/components/examples/import400ErrorInvalidParameters' Missing Parameters: $ref: '#/components/examples/import400ErrorMissingParameters' Unsupported OpenAPI Version: $ref: '#/components/examples/import400ErrorUnsupportedOASVersion' managePartnerWorkspaceInvitesResponse: description: Successful Response content: application/json: schema: oneOf: - $ref: '#/components/schemas/managePartnerWorkspaceInvitesInvitePartnerResponse' - $ref: '#/components/schemas/managePartnerWorkspaceInvitesRemovePartnerResponse' examples: Invite Partners to a Partner Workspace: $ref: '#/components/examples/managePartnerWorkspaceInvitesInvitePartnerResponse' Partial Invite Success: $ref: '#/components/examples/managePartnerWorkspaceInvitesInvitePartnerPartialSuccessResponse' Partial Partners Removal Success: $ref: '#/components/examples/managePartnerWorkspaceInvitesPartialRemovePartnerResponse' Remove Partner from a Workspace: $ref: '#/components/examples/managePartnerWorkspaceInvitesRemovePartnerFromWorkspaceResponse' Remove Partner From Partnership: $ref: '#/components/examples/managePartnerWorkspaceInvitesRemovePartnerFromTeamResponse' managePartnerWorkspaceInvites400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Invalid Action: $ref: '#/components/examples/managePartnerWorkspaceInvites400ErrorInvalidAction' Invalid Partner Workspace: $ref: '#/components/examples/managePartnerWorkspaceInvites400ErrorInvalidPartnerWorkspace' Invalid Workspace Role: $ref: '#/components/examples/managePartnerWorkspaceInvites400ErrorInvalidWorkspaceRole' Missing Request Body Properties: $ref: '#/components/examples/managePartnerWorkspaceInvites400ErrorMissingProperties' managePartnerWorkspaceInvites401Error: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Unauthorized: $ref: '#/components/examples/common401Error' managePartnerWorkspaceInvites403Error: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Forbidden: $ref: '#/components/examples/managePartnerWorkspaceInvites403ErrorForbidden' managePartnerWorkspaceInvites404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Not Found: $ref: '#/components/examples/managePartnerWorkspaceInvites404ErrorNotFound' getAuthenticatedUser: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getAuthenticatedUser' examples: Successful Response: $ref: '#/components/examples/getAuthenticatedUser' getMocks: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getMocks' examples: Successful Response: $ref: '#/components/examples/getMocks' Filter by teamId: $ref: '#/components/examples/getMocksFilterByTeamId' Filter by workspace: $ref: '#/components/examples/getMocksFilterByWorkspace' No Mocks Found: $ref: '#/components/examples/getMocksNoMocksFound' mock500Error: description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/mock500Error' examples: Internal Server Error: $ref: '#/components/examples/common500ErrorServerErrorSomethingWrong' mockCreateUpdate: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/mockCreateUpdateResponse' examples: Update Mock Properties: $ref: '#/components/examples/mockCreateUpdate' Update Collection and Environment: $ref: '#/components/examples/updateMockCollectionEnvironmentResponse' Activate a Server Response: $ref: '#/components/examples/updateMockActivateServerResponse' Deactivate a Server Response: $ref: '#/components/examples/updateMockDeactivateServerResponse' getMock: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getMock' examples: Successful Response: $ref: '#/components/examples/getMock' mock404Error: description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: Mock Not Found: $ref: '#/components/examples/mock404ErrorInstanceNotFound' mock400Error: description: Bad Request content: application/json: schema: anyOf: - $ref: '#/components/schemas/commonErrorNameMessage' - $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: Bad Request: $ref: '#/components/examples/mock400ErrorCreateMissingCollection' Collection API Error: $ref: '#/components/examples/mock400ErrorCollectionApiError' Mock Already Published: $ref: '#/components/examples/mock400ErrorAlreadyPublished' Mock Already Unpublished: $ref: '#/components/examples/mock400ErrorAlreadyUnpublished' Log Retention Period Exceeded: $ref: '#/components/examples/mock400ErrorLogRetentionPeriodExceeded' Missing Parameter: $ref: '#/components/examples/mock400ErrorPutMissingParam' deleteMock: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/deleteMock' examples: Mock Deleted: $ref: '#/components/examples/deleteMock' getMockCallLogs: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getMockCallLogs' examples: Successful Response: $ref: '#/components/examples/getMockCallLogs' Filter by Limit: $ref: '#/components/examples/getMockCallLogsFilterByLimit' Filter by Cursor: $ref: '#/components/examples/getMockCallLogsFilterByCursor' Filter by a Date Range: $ref: '#/components/examples/getMockCallLogsFilterByDateRange' Filter by Date Since: $ref: '#/components/examples/getMockCallLogsFilterByDateSince' Filter by responseStatusCode: $ref: '#/components/examples/getMockCallLogsFilterByResponseStatusCode' Filter by responseType: $ref: '#/components/examples/getMockCallLogsFilterByResponseType' Filter by requestMethod: $ref: '#/components/examples/getMockCallLogsFilterByRequestMethod' Filter by requestPath: $ref: '#/components/examples/getMockCallLogsFilterByRequestPath' Sort by servedAt: $ref: '#/components/examples/getMockCallLogsSortByServedAt' Filter by Header and Body Data: $ref: '#/components/examples/getMockCallLogsFilterByHeaderAndBody' publishMock: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/publishUnpublishMockResponse' examples: Mock Published: $ref: '#/components/examples/publishUnpublishMockResponse' unpublishMock: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/publishUnpublishMockResponse' examples: Mock Unpublished: $ref: '#/components/examples/publishUnpublishMockResponse' getMockServerResponses: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getMockServerResponses' examples: Successful Response: $ref: '#/components/examples/getMockServerResponses' mockServerResponse404Error: description: Not Found content: application/json: schema: $ref: '#/components/schemas/mockServerResponse404Error' examples: Mock Not Found: $ref: '#/components/examples/mockServerResponse404ErrorMockNotFound' Server Response Not Found: $ref: '#/components/examples/mockServerResponse404ErrorServerResponseNotFound' mockServerResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/mockServerResponse' examples: Successful Response: $ref: '#/components/examples/mockServerResponse' deleteMockServerResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/deleteMockServerResponse' examples: Server Response Deleted: $ref: '#/components/examples/deleteMockServerResponse' getMonitors: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getMonitors' examples: Successful Response: $ref: '#/components/examples/getMonitors' Get Monitors in a Workspace: $ref: '#/components/examples/getMonitorsInWorkspace' Filter by collectionUid: $ref: '#/components/examples/getMonitorsFilterByCollectionUid' Filter by environmentUid: $ref: '#/components/examples/getMonitorsFilterByEnvironmentUid' Filter by active: $ref: '#/components/examples/getMonitorsActiveFilter' Filter by owner: $ref: '#/components/examples/getMonitorsOwnerFilter' Limit with Cursor Pagination: $ref: '#/components/examples/getMonitorsLimitCursorPagination' Owner Not Found: $ref: '#/components/examples/getMonitorsOwnerNotFound' Collection Not Found: $ref: '#/components/examples/getMonitorsCollectionNotFound' Environment Not Found: $ref: '#/components/examples/getMonitorsEnvironmentNotFound' monitors400Errors: description: Bad Request content: application/json: schema: anyOf: - $ref: '#/components/schemas/commonErrorNameMessage' - $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: Forbidden Error: $ref: '#/components/examples/createMonitor400ErrorForbidden' Invalid active Value: $ref: '#/components/examples/getMonitors400ErrorInvalidActive' Invalid Collection UID: $ref: '#/components/examples/monitors400ErrorInvalidCollectionUid' Invalid Cron Pattern: $ref: '#/components/examples/monitors400ErrorInvalidCronPattern' Invalid Cursor: $ref: '#/components/examples/getMonitors400ErrorInvalidCursor' Invalid Environment UID: $ref: '#/components/examples/monitors400ErrorInvalidEnvironmentUid' Invalid owner Value: $ref: '#/components/examples/getMonitors400ErrorInvalidOwner' Invalid Pagination Limit: $ref: '#/components/examples/getMonitors400ErrorInvalidPagination' Invalid Parameters: $ref: '#/components/examples/updateMonitor400ErrorInvalidParameters' Invalid Timezone: $ref: '#/components/examples/monitors400ErrorInvalidTimezone' Invalid Workspace ID: $ref: '#/components/examples/getMonitors400ErrorInvalidWorkspace' Missing name Parameter: $ref: '#/components/examples/monitors400ErrorMissingParameter' Missing cron Parameter: $ref: '#/components/examples/updateMonitor400ErrorMissingParameter' monitors404Error: description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorNameMessage' examples: Monitor Not Found: $ref: '#/components/examples/monitors404ErrorInstanceNotFoundMonitor' Workspace ID Not Found: $ref: '#/components/examples/monitors404ErrorMonitorIdNotFound' Workspace Not Found: $ref: '#/components/examples/monitors404ErrorWorkspaceNotFound' createMonitor: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/createUpdateMonitorResponse' examples: Monitor Created: $ref: '#/components/examples/createUpdateMonitorResponse' Create Monitor with Options: $ref: '#/components/examples/createMonitorWithOptionsResponse' getMonitor: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getMonitor' examples: Successful Response: $ref: '#/components/examples/getMonitor' updateMonitor: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/createUpdateMonitorResponse' examples: Monitor Updated: $ref: '#/components/examples/createUpdateMonitorResponse' Pause Monitor: $ref: '#/components/examples/updateMonitorPauseResponse' Resume Monitor: $ref: '#/components/examples/updateMonitorResumeResponse' deleteMonitor: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/deleteMonitor' examples: Monitor Deleted: $ref: '#/components/examples/deleteMonitor' runMonitor: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/runMonitor' examples: Successful Response: $ref: '#/components/examples/runMonitor' Run With async Parameter: $ref: '#/components/examples/runMonitorAsyncParam' Monitor Run Failed: $ref: '#/components/examples/runMonitorFailedResponse' Monitor Run with Errors: $ref: '#/components/examples/runMonitorWithErrorsResponse' runMonitor202: description: Accepted content: application/json: schema: $ref: '#/components/schemas/runMonitor202' examples: Run Exceeds 300s: $ref: '#/components/examples/runMonitor202' getPanElements: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getPanElements' examples: Successful Response: $ref: '#/components/examples/getPanElements' postPanElement: description: Created content: application/json: schema: $ref: '#/components/schemas/panElementCreated' examples: Add a Workspace: $ref: '#/components/examples/panElementCreated' pan404Error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/panError' examples: Element Not Found: $ref: '#/components/examples/pan404ErrorElement' deletePanElement: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/deletePanElement' examples: Remove a Workspace: $ref: '#/components/examples/deletePanElement' pan400Error: description: Bad Request content: application/json: schema: anyOf: - $ref: '#/components/schemas/panError' - $ref: '#/components/schemas/commonErrorNameMessage' examples: Invalid Parameter: $ref: '#/components/examples/pan400ErrorInvalidParams' Invalid Query Parameter: $ref: '#/components/examples/pan400ErrorInvalidQueryParams' Request Not Found: $ref: '#/components/examples/pan400ErrorNotFoundRequestId' Element Already Published: $ref: '#/components/examples/pan400ErrorElementAlreadyPublished' Request Already Responded To: $ref: '#/components/examples/pan400ErrorAlreadyResponded' getAllPanAddElementRequests: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getAllPanAddElementRequests' examples: Successful Response: $ref: '#/components/examples/getAllPanAddElementRequests' respondPanElementAddRequest: description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/respondPanElementAddRequestApprove' - $ref: '#/components/schemas/respondPanElementAddRequestDeny' examples: Request Approved: $ref: '#/components/examples/respondPanElementAddRequestApproveResponse' Request Denied: $ref: '#/components/examples/respondPanElementAddRequestDenyResponse' generateOauthTokenResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/generateOauthTokenResponse' examples: Successful Response: $ref: '#/components/examples/generateOauthTokenResponse' oauthToken400Error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/oauthTokenError' examples: Unsupported Grant Type: $ref: '#/components/examples/oauthToken400ErrorUnsupportedGrantType' oauthToken404Error: description: Not Found content: application/json: schema: $ref: '#/components/schemas/oauthTokenError' examples: OAuth Client Installation Not Found: $ref: '#/components/examples/oauthToken404ErrorClientInstallationNotFound' OAuth Client Not Found: $ref: '#/components/examples/oauthToken404ErrorOAuthClientNotFound' Token Not Found: $ref: '#/components/examples/oauthToken404ErrorTokenNotFound' revokeOauthTokenResponse: description: Token Revoked content: application/json: schema: $ref: '#/components/schemas/revokeOauthTokenResponse' examples: Token Revoked: $ref: '#/components/examples/revokeOauthTokenResponse' getPackages: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getPackages' examples: Successful Response: $ref: '#/components/examples/getPackages' packages400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Invalid Format: $ref: '#/components/examples/packages400ErrorInvalidFormatLength' packages401Error: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Unauthorized: $ref: '#/components/examples/packages401ErrorUnauthorized' packages403Error: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Forbidden: $ref: '#/components/examples/packages403ErrorForbidden' packages429Error: description: Rate Limit Exceeded content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Rate Limit Exceeded: $ref: '#/components/examples/packages429ErrorRateLimitExceeded' packages500Error: description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Internal Server Error: $ref: '#/components/examples/packages500ErrorInternalServerError' createPackageResponse: description: Package Created content: application/json: schema: $ref: '#/components/schemas/createPackageResponse' examples: Package Created: $ref: '#/components/examples/createPackageResponse' packages409Error: description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Conflict: $ref: '#/components/examples/packages409ErrorConflict' getPackage: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getPackage' examples: Unified Package: $ref: '#/components/examples/getPackageUnifiedPackage' packages404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Blob Not Found: $ref: '#/components/examples/packages404ErrorBlobNotFound' Package Not Found: $ref: '#/components/examples/packages404ErrorPackageNotFound' updatePackageResponse: description: Package Updated content: application/json: schema: $ref: '#/components/schemas/updatePackageResponse' examples: Package Updated: $ref: '#/components/examples/updatePackageResponse' generateTool: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/generateToolResponse' examples: Successful Response: $ref: '#/components/examples/generateToolResponse' postbot400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/postbot400Error' examples: Bad Request: $ref: '#/components/examples/postbot400ErrorBadRequest' Collection Not Found: $ref: '#/components/examples/postbot400ErrorCollectionNotFoundNotPublic' Collection Not Public: $ref: '#/components/examples/postbot400ErrorCollectionNotFoundNotPublic' Invalid Framework: $ref: '#/components/examples/postbot400ErrorInvalidFramework' Invalid Language: $ref: '#/components/examples/postbot400ErrorInvalidLanguage' Missing Property: $ref: '#/components/examples/postbot400ErrorMissingProperty' Request Not Found: $ref: '#/components/examples/postbot400ErrorRequestNotFound' getPullRequest: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/pullRequestGet' example: createdAt: '2024-02-20T09:55:46.000Z' updatedAt: '2024-02-20T09:58:38.000Z' id: 4e1a6609-1a29-4037-a411-89ecc14c6cd8 title: Test PR description: This is a test pull request. createdBy: '12345678' updatedBy: '12345678' comment: Missing descriptions in requests forkType: collection source: id: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef name: test-collection forkName: Taylor Lee's fork exists: true destination: id: 123456789-24f57217-1169-4b7c-a810-0e957c04eaa5 name: test-collection exists: true status: declined merge: status: inactive reviewers: - id: '12345678' status: declined pullRequestUpdate: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/pullRequestUpdated' example: createdAt: '2024-02-20T09:58:57.000Z' createdBy: '12345678' description: Updated description of the pull request. destinationId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 forkType: collection id: 4e1a6609-1a29-4037-a411-89ecc14c6cd8 sourceId: 87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef status: open title: Updated PR title updatedAt: '2024-02-20T09:58:57.000Z' pullRequest409Error: description: Conflict content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Conflict: $ref: '#/components/examples/pullRequest409ErrorConflict' pullRequestReviewResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/pullRequestReviewReponse' examples: Approved: value: id: 4e1a6609-1a29-4037-a411-89ecc14c6cd8 reviewedBy: id: 12345678 name: Taylor Lee username: taylor-lee status: approved updatedAt: '2024-02-21T08:19:09.000Z' Merged: value: id: 4e1a6609-1a29-4037-a411-89ecc14c6cd8 reviewedBy: id: 12345678 name: Taylor Lee username: taylor-lee status: merged updatedAt: '2024-02-21T08:19:09.000Z' Declined: value: id: 4e1a6609-1a29-4037-a411-89ecc14c6cd8 reviewedBy: id: 12345678 name: Taylor Lee username: taylor-lee status: declined updatedAt: '2024-02-21T08:19:09.000Z' Unpproved: value: id: 4e1a6609-1a29-4037-a411-89ecc14c6cd8 reviewedBy: id: 12345678 name: Taylor Lee username: taylor-lee status: open updatedAt: '2024-02-21T08:19:09.000Z' getRunnerInstances: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getRunnerInstances' examples: Successful Response: $ref: '#/components/examples/getRunnerInstances' Response with Limit and Cursor: $ref: '#/components/examples/getRunnerInstancesCursorLimit' No Runner Data: $ref: '#/components/examples/getRunnerInstancesNoData' runner400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/runnerErrorTypeTitleDetailCreatedAt' examples: Invalid Pagination Limit: $ref: '#/components/examples/runner400ErrorInvalidPaginationLimit' runner404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/runnerErrorTypeTitleDetailCreatedAt' examples: Runner Not Found: $ref: '#/components/examples/runner404ErrorRunnerNotFound' getRunnerMetrics: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getRunnerMetrics' examples: Successful Response: $ref: '#/components/examples/getRunnerMetrics' getAllRulesets: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/rulesetList' examples: Successful Response: $ref: '#/components/examples/getAllRulesets' createRuleset: description: Ruleset Created content: application/json: schema: $ref: '#/components/schemas/writeResult' examples: Ruleset Created: $ref: '#/components/examples/createRulesetResponse' ruleset409Conflict: description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Ruleset Name Conflict: $ref: '#/components/examples/apiGovernance409ErrorRulesetNameConflict' getRuleset: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ruleset' examples: Successful Response: $ref: '#/components/examples/getRuleset' With Content: $ref: '#/components/examples/getRulesetWithContent' updateRuleset: description: Ruleset Updated content: application/json: schema: $ref: '#/components/schemas/writeResult' examples: Ruleset Updated: $ref: '#/components/examples/updateRulesetResponse' getRulesetAssignments: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/rulesetAssignmentList' examples: Successful Response: $ref: '#/components/examples/getRulesetAssignments' createRulesetAssignment: description: Ruleset Assignment Created content: application/json: schema: $ref: '#/components/schemas/rulesetAssignmentSummary' examples: Ruleset Assignment Created: $ref: '#/components/examples/createRulesetAssignmentResponse' rulesetAssignment409Conflict: description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Ruleset Assignment Conflict: $ref: '#/components/examples/apiGovernance409ErrorRulesetAssignmentConflict' deleteRulesetAssignment: description: Deleted content: application/json: schema: $ref: '#/components/schemas/emptyObject' examples: Ruleset Assignment Deleted: $ref: '#/components/examples/deleteRulesetAssignmentResponse' getSecretTypes: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getSecretTypes' examples: Successful Response: $ref: '#/components/examples/getSecretTypes' schemaSecurityValidation: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/schemaSecurityValidationResponse' examples: No Warnings Found: $ref: '#/components/examples/schemaSecurityValidationNoWarnings' Successful Response with Governance Warnings: $ref: '#/components/examples/schemaSecurityValidationGovernanceWarnings' Successful Response with Security Warnings: $ref: '#/components/examples/schemaSecurityValidationSecurityWarnings' apiSecurity400Error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorNameObjectNameMessage' examples: Invalid Schema: $ref: '#/components/examples/apiSecurity400ErrorInvalidSchema' getTaggedEntities: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getTaggedEntities' examples: Successful Response: $ref: '#/components/examples/getTaggedEntities' Successful Response With Next Cursor: $ref: '#/components/examples/getTaggedEntitiesWithNextCursor' tagElement400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/tagElement400Error' examples: Bad Request: $ref: '#/components/examples/tagElement400Error' getScimGroupResources: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getScimGroupResources' examples: Successful Response: $ref: '#/components/examples/getScimGroupResources' scim400ErrorInvalidFilter: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/scimError' examples: Unsupprted Filter: $ref: '#/components/examples/scim400ErrorInvalidFilter' scim401Error: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/scimError' examples: Unauthorized: $ref: '#/components/examples/scim401Error' scim403Error: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/scimError' examples: Invalid API Key: $ref: '#/components/examples/scim403Error' Admin Action Not Allowed: $ref: '#/components/examples/scim403ErrorAdminActionNotAllowed' User Not In Team: $ref: '#/components/examples/scim403ErrorUserNotInTeam' scimGroup500Error: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/scimError' examples: Internal Server Error: $ref: '#/components/examples/scimGroup500Error' createScimGroup: description: Created content: application/json: schema: $ref: '#/components/schemas/createScimGroupResponse' examples: SCIM Group Created: $ref: '#/components/examples/createScimGroupResponse' scim400ErrorInvalidSyntax: description: Bad Request content: application/json: schema: anyOf: - $ref: '#/components/schemas/scimErrorScimType' - $ref: '#/components/schemas/scimError' examples: Invalid Syntax: $ref: '#/components/examples/scim400ErrorInvalidSyntax' Not Enterprise: $ref: '#/components/examples/scim400ErrorNotEnterprise' No Slots Available: $ref: '#/components/examples/scim400ErrorNoSlots' scim409Error: description: Conflict content: application/json: schema: $ref: '#/components/schemas/scimErrorScimType' examples: User Already On Team: $ref: '#/components/examples/scim409Error' scimUpdateGroup500Error: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/scimError' examples: Internal Server Error: $ref: '#/components/examples/scimUpdateGroup500Error' getScimGroupResource: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getScimGroupResource' examples: Successful Response: $ref: '#/components/examples/getScimGroupResource' scim400Error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/scimError' examples: Team Does Not Exist: $ref: '#/components/examples/scim400Error' scimGroup404Error: description: Not Found content: application/json: schema: $ref: '#/components/schemas/scimError' examples: Group Not Found: $ref: '#/components/examples/scimGroup404Error' scim500Error: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/scimError' examples: Internal Server Error: $ref: '#/components/examples/scim500Error' scimUpdateGroup: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/scimUpdateGroupResponse' examples: SCIM Group Updated: $ref: '#/components/examples/scimUpdateGroupResponse' getScimResourceTypes: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getScimResourceTypes' examples: Successful Response: $ref: '#/components/examples/getScimResourceTypes' getScimServiceProviderConfig: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getScimServiceProviderConfig' examples: Successful Response: $ref: '#/components/examples/getScimServiceProviderConfig' getScimUserResources: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/scimUserResources' examples: Successful Response: $ref: '#/components/examples/getScimUserResources' Filter Inactive Users: $ref: '#/components/examples/getInactiveScimUserResources' createScimUser: description: Created content: application/json: schema: $ref: '#/components/schemas/createScimUserResponse' examples: SCIM User Created: $ref: '#/components/examples/createScimUserResponse' scimUserResourceResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/scimUserResourceResponse' examples: Successful Response: $ref: '#/components/examples/scimUserResourceResponse' scim404Error: description: Not Found content: application/json: schema: $ref: '#/components/schemas/scimError' examples: Invalid Team Member: $ref: '#/components/examples/scim404Error' scim500ErrorUser: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/scimError' examples: Cannot Get User Info: $ref: '#/components/examples/scim500ErrorUser' scimUpdateUser400Error: description: Bad Request content: application/json: schema: anyOf: - $ref: '#/components/schemas/scimError' - $ref: '#/components/schemas/scimErrorScimType' examples: Invalid Syntax: $ref: '#/components/examples/scim400ErrorInvalidSyntax' Invalid Team: $ref: '#/components/examples/scim400Error' Invalid User Email Address: $ref: '#/components/examples/scimUserDomainInvalidEmail400Error' Unverified Domain: $ref: '#/components/examples/scimUserDomainUnverified400Error' getSdks: description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/sdkList' examples: A Page of SDKs: $ref: '#/components/examples/sdkList' Filter by Failed Builds: $ref: '#/components/examples/sdkListFailed' Filter by Language: $ref: '#/components/examples/sdkListByLanguage' Batch-poll by ID: $ref: '#/components/examples/sdkListBatchPoll' sdk400ErrorInvalidListQuery: description: Invalid Query content: application/problem+json: schema: $ref: '#/components/schemas/sdkError' examples: Malformed cursor Value: $ref: '#/components/examples/sdk400ErrorInvalidListQuery' createSdk: description: Successful Response headers: Location: description: The URL of the created SDK resource. schema: type: string format: uri example: https://api.postman.com/sdks/9c4e7d1a-2b3c-4f5e-8a9b-1c2d3e4f5a6b sdk400ErrorInvalidCreateRequest: description: Malformed Request content: application/problem+json: schema: $ref: '#/components/schemas/sdkError' examples: Invalid Create Request: $ref: '#/components/examples/sdk400ErrorInvalidCreateRequest' sdk422Error: description: Unprocessable Entity content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Unsupported Language: $ref: '#/components/examples/sdk422ErrorUnsupportedLanguageForSourceType' getSdk: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/sdk' examples: Successful Response: $ref: '#/components/examples/sdk' sdk409Error: description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Conflict: $ref: '#/components/examples/sdk409ErrorRequestConflict' Git Connection Already Exists: $ref: '#/components/examples/sdkGitConnection409ErrorAlreadyConnected' getSdkDownloadUrl: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/sdkDownload' examples: Successful Response: $ref: '#/components/examples/sdkDownload' getSdkGitConnections: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/sdkGitConnectionList' examples: Successful Response: $ref: '#/components/examples/sdkGitConnectionList' sdkGitConnection400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/sdkError' examples: Missing workspaceId Parameter: $ref: '#/components/examples/sdkGitConnection400ErrorInvalidListQuery' Git Connection Already Exists: $ref: '#/components/examples/sdkGitConnection400ErrorInvalidCreateRequest' Invalid Transition Status: $ref: '#/components/examples/sdkGitConnection400ErrorInvalidStatusTransition' createSdkGitConnectionResponse: description: Successful Response headers: Location: description: The URL of the created Git connection resource. schema: type: string format: uri example: https://api.postman.com/sdks/9c4e7d1a-2b3c-4f5e-8a9b-1c2d3e4f5a6b content: application/json: schema: $ref: '#/components/schemas/sdkGitConnection' examples: Created Git Connection: $ref: '#/components/examples/sdkGitConnection' getSdkGitConnection: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/sdkGitConnection' examples: Successful Response: $ref: '#/components/examples/sdkGitConnection' updateSdkGitConnectionResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/sdkGitConnection' examples: Successful Response: $ref: '#/components/examples/sdkGitConnection' getSdkGitConnectionPullRequests: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/sdkGitConnectionPullRequestList' examples: Successful Response: $ref: '#/components/examples/sdkGitConnectionPullRequestList' searchPostmanResourcesResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/searchPostmanResourcesResponse' examples: Search Team's Public Workspace: $ref: '#/components/examples/searchPostmanResourcesResponsePublicWorkspaces' No Results Found: $ref: '#/components/examples/searchPostmanResourcesNoResultsFound' searchPostman400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Missing elementType Property: $ref: '#/components/examples/searchPostman400ErrorMissingElementTypeProperty' Invalid ownership Value: $ref: '#/components/examples/searchPostman400ErrorInvalidOwnershipValue' Invalid ownership And Visibility Combination: $ref: '#/components/examples/searchPostman400ErrorInvalidOwnershipAndVisibilityCombination' Invalid privateNetwork and ownership Combination: $ref: '#/components/examples/searchPostman400ErrorInvalidPrivateNetworkAndOwnershipCombination' getAllSpecs: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getAllSpecs' examples: Successful Response: $ref: '#/components/examples/getAllSpecs' apiSpec400Error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Element Not Found: $ref: '#/components/examples/apiSpec400ErrorInvalidTaskId' File Size Exceeded: $ref: '#/components/examples/apiSpecFile400ErrorFileSizeExceeded' Invalid Collection UID: $ref: '#/components/examples/apiSpec400ErrorInvalidCollectionUid' Invalid Parameter Error: $ref: '#/components/examples/apiSpec400ErrorInvalidParamError' Invalid type Parameter: $ref: '#/components/examples/apiSpec400ErrorFilesInvalidTypeParam' Malformed Request: $ref: '#/components/examples/apiSpec400ErrorMalformedRequest' Malformed Specification: $ref: '#/components/examples/apiSpec400ErrorMalformedSpecification' Missing content Parameter: $ref: '#/components/examples/apiSpec400ErrorFilesInvalidMissingContentParam' Missing files Parameter: $ref: '#/components/examples/apiSpec400ErrorFilesInvalidMissingFilesParam' Missing name Property: $ref: '#/components/examples/apiSpec400ErrorMissingNameProperty' Missing ROOT file: $ref: '#/components/examples/apiSpecFile400ErrorMissingRootFile' Multiple ROOT Files: $ref: '#/components/examples/apiSpecFile400ErrorMultipleRootFiles' Workspace Not Found: $ref: '#/components/examples/apiSpec400ErrorWorkspaceNotFound' createSpecResponse: description: Created content: application/json: schema: $ref: '#/components/schemas/createSpecResponse' examples: Spec Created: $ref: '#/components/examples/createSpecResponse' getSpec: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/specData' examples: Successful Response: $ref: '#/components/examples/getSpec' updateSpecPropertiesResponse: description: Spec Updated content: application/json: schema: $ref: '#/components/schemas/updateSpecPropertiesResponse' examples: Rename Spec: $ref: '#/components/examples/updateSpecPropertiesResponse' updateSpecSyncOptionsResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/apiSpecSyncOptions' examples: Successful Response: $ref: '#/components/examples/updateSpecSyncOptionsResponse' apiSpecSyncOptions400Error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Empty Request Body: $ref: '#/components/examples/apiSpecSyncOptions400ErrorMalformedRequest' apiSpecSyncOptions401Error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Unauthorized: $ref: '#/components/examples/apiSpecSyncOptions401Error' getSpecDefinition: description: Successful Response content: application/json: examples: Successful JSON Response: $ref: '#/components/examples/getSpecDefinitionJson' application/yaml: examples: Successful YAML Response: $ref: '#/components/examples/getSpecDefinitionYaml' getSpecFiles: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getSpecFiles' examples: Successful Response: $ref: '#/components/examples/getSpecFiles' createUpdateSpecFileResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/createUpdateSpecFileResponse' examples: JSON Spec File: $ref: '#/components/examples/createUpdateSpecFileResponseJson' YAML Spec File: $ref: '#/components/examples/createUpdateSpecFileResponseYaml' Protobuf Spec File: $ref: '#/components/examples/createUpdateSpecFileResponseProtobuf' Nested Spec File: $ref: '#/components/examples/createUpdateSpecFileResponseNested' apiSpecFiles400Error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Empty Request Body: $ref: '#/components/examples/apiSpecFile400ErrorInvalidPathValue' File Size Exceeded: $ref: '#/components/examples/apiSpecFile400ErrorFileSizeExceeded' Invalid filePath Parameter: $ref: '#/components/examples/apiSpecFile400ErrorInvalidFilePath' Invalid path Property: $ref: '#/components/examples/apiSpecFile400ErrorInvalidPathValue' Invalid Request Body: $ref: '#/components/examples/apiSpecFile400ErrorInvalidRequestBody' Malformed Request: $ref: '#/components/examples/apiSpecFile400ErrorInvalidFileExtension' getSpecFile: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getSpecFile' examples: Successful Response: $ref: '#/components/examples/getSpecFile' Nested Spec File: $ref: '#/components/examples/getSpecFileNested' getSpecCollections: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getSpecCollections' examples: Successful Response: $ref: '#/components/examples/getSpecCollections' getSpecVersionTag: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getSpecVersionTag' examples: Successful Response: $ref: '#/components/examples/getSpecVersionTagFile' Multi-File Response: $ref: '#/components/examples/getSpecVersionTagMultiFile' getSpecVersionTags: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getSpecVersionTags' examples: Successful Response: $ref: '#/components/examples/getSpecVersionTags' createSpecVersionTagResponse: description: Created content: application/json: schema: $ref: '#/components/schemas/createSpecVersionTagResponse' examples: Successful Response: $ref: '#/components/examples/createSpecVersionTagResponse' apiSpec409Error: description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Version Tag Conflict: $ref: '#/components/examples/apiSpec409ErrorVersionTagConflict' getTeams: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: A list of teams. items: $ref: '#/components/schemas/teamData' metadata: $ref: '#/components/schemas/metaDataNextCursor' examples: Successful Response: $ref: '#/components/examples/getTeams' teams400Error: description: Bad Request content: application/problem+json: schema: oneOf: - $ref: '#/components/schemas/teamsError' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: Team Feature Unavailable: $ref: '#/components/examples/teams401ErrorTeamFeatureUnavailable' Team Name Already Exists: $ref: '#/components/examples/teams400ErrorTeamNameAlreadyExists' Team ID Not Found: $ref: '#/components/examples/teams400ErrorTeamIdNotFound' Invalid Action: $ref: '#/components/examples/teams400ErrorInvalidAction' Invalid Team Name: $ref: '#/components/examples/teams400ErrorTeamNameInvalid' Entities Not Part of Team: $ref: '#/components/examples/teams400ErrorEntitiesNotPartOfTeam' Invalid Entries for Manage Team Member Roles: $ref: '#/components/examples/teams400ErrorAddRemoveWithFailures' Team Request Has Invalid Role: $ref: '#/components/examples/teams400ErrorTeamRequestInvalidRole' teams401Error: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: API Key Missing: $ref: '#/components/examples/teams401ErrorUnauthorized' teams500Error: description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/teamsError' examples: Internal Server Error: $ref: '#/components/examples/teams500ErrorInternalServerError' createGetTeamResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/createGetTeamResponse' examples: Successful Response: $ref: '#/components/examples/createGetTeamResponse' teams403Error: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/teamsError' examples: No Access Request Access Permissions: $ref: '#/components/examples/teams403ErrorTeamNoAccessRequestPermissions' No Access Request Management Permissions: $ref: '#/components/examples/teams403ErrorNoAccessRequestsManagementPermission' No Team Create Permissions: $ref: '#/components/examples/teams403ErrorNoTeamCreatePermission' Cannot Remove Team Members: $ref: '#/components/examples/teams403ErrorCannotRemoveTeamMembers' getTeamAccessRequests: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getTeamAccessRequests' examples: Successful Response: $ref: '#/components/examples/getTeamAccessRequests' Response with SCIM IDs: $ref: '#/components/examples/getTeamAccessRequestsScimId' createTeamAccessRequestResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/createAccessRequestResponse' examples: Request a Role for User: $ref: '#/components/examples/createAccessRequestUserRoleResponse' Request User as Guest Viewer: $ref: '#/components/examples/createAccessRequestGuestRoleResponse' Request to Add Users as Guest Developers: $ref: '#/components/examples/createAccessRequestGuestDevelopersResponse' Request a Role Upgrade: $ref: '#/components/examples/createAccessRequestRoleUpgradeResponse' Request Team as Guest Viewer to a Team: $ref: '#/components/examples/createAccessRequestGuestTeamViewerResponse' Request to Add Organization: $ref: '#/components/examples/createAccessRequestAddOrganizationResponse' Request Organization Role Upgrade: $ref: '#/components/examples/createAccessRequestOrganizationRoleUpgradeResponse' Request Accepted With Existing Requests: $ref: '#/components/examples/createAccessRequestAcceptedWithExistingRequestsResponse' User Already Has Role: $ref: '#/components/examples/createAccessRequestUserHasRoleResponse' approveDenyAccessRequestResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/approveDenyAccessRequestResponse' examples: Approve an Access Request: $ref: '#/components/examples/approveDenyAccessRequestResponse' Deny an Access Request: $ref: '#/components/examples/approveDenyAccessRequestDenyResponse' teams404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/teamsError' examples: Access Request Not Found: $ref: '#/components/examples/teams404ErrorAccessRequestNotFound' manageTeamMemberRolesResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/manageTeamMemberRolesResponse' examples: Assign Team Member's Role: $ref: '#/components/examples/manageTeamMemberRolesAssignTeamMemberRoleResponse' Update Team Member's Role: $ref: '#/components/examples/manageTeamMemberRolesUpdateTeamMemberRoleResponse' Update Team Organization's Role: $ref: '#/components/examples/manageTeamMemberRolesUpdateTeamOrgRoleResponse' Update Team Role: $ref: '#/components/examples/manageTeamMemberRolesUpdateTeamRoleResponse' Update Team Member's Role with SCIM ID: $ref: '#/components/examples/manageTeamMemberRolesUpdateTeamRoleScimIdResponse' Remove Team Member's Role: $ref: '#/components/examples/manageTeamMemberRolesRemoveTeamRoleResponse' Add and Remove Roles: $ref: '#/components/examples/manageTeamMemberRolesAddRemoveRolesResponse' Add and Remove Roles with SCIM IDs: $ref: '#/components/examples/manageTeamMemberRolesAddRemoveRolesScimIdResponse' createGetTeamSettingsResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/createGetTeamSettingsResponse' examples: Successful Response: $ref: '#/components/examples/createGetTeamSettingsResponse' getTeamUsers: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getTeamUsers' examples: Successful Response: $ref: '#/components/examples/getTeamUsers' Filter by groupId: $ref: '#/components/examples/getTeamUsersFilterGroup' No Group Found: $ref: '#/components/examples/getTeamUsersNoGroupFound' getTeamUser: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/teamUser' examples: Successful Response: $ref: '#/components/examples/getTeamUser' createWebhook: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/createWebhookResponse' examples: Webhook Created: $ref: '#/components/examples/createWebhookResponse' createWebhookParamMissing400Error: description: Missing Parameter content: application/json: schema: $ref: '#/components/schemas/commonErrorNameMessageDetails' examples: Missing Parameter: $ref: '#/components/examples/createWebhookParamMissing400Error' getWorkspaces: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getWorkspaces' examples: Successful Response: $ref: '#/components/examples/getWorkspaces' Include SCIM IDs: $ref: '#/components/examples/getWorkspacesIncludeScimIds' Response With Pagination: $ref: '#/components/examples/getWorkspacesPaginationResponse' workspaces400Error: description: Bad Request content: application/json: schema: anyOf: - $ref: '#/components/schemas/workspace400Error' - $ref: '#/components/schemas/commonErrorNameMessageOnly' - $ref: '#/components/schemas/commonErrorNameMessage' examples: Invalid type Filter: $ref: '#/components/examples/workspace400ErrorInvalidTypeFilter' Missing elementId Filter: $ref: '#/components/examples/workspace400ErrorMissingElementIdFilter' Invalid elementType Filter: $ref: '#/components/examples/workspace400ErrorInvalidElementTypeFilter' Invalid limit Value: $ref: '#/components/examples/workspace400ErrorInvalidLimitValue' common429ErrorRateLimited: description: Rate Limit Exceeded content: application/json: schema: $ref: '#/components/schemas/commonErrorErrorMessage' examples: Rate Limit Exceeded: $ref: '#/components/examples/common429ErrorRateLimited' createWorkspace: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/createWorkspaceResponse' examples: Workspace Created: $ref: '#/components/examples/createWorkspaceResponse' workspacePostPut400Errors: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorNameMessage' examples: Workspace Missing: $ref: '#/components/examples/workspace400ErrorMalformedRequest' Publish Limit Exceeded: $ref: '#/components/examples/workspacePostPut400ErrorPublicPublishLimit' Not a Unique Public Workspace Name: $ref: '#/components/examples/workspacePostPut400ErrorNotUniqueWorkspaceName' Missing name Property: $ref: '#/components/examples/workspacePostPut400ErrorMissingName' workspace403ErrorUnauthorized: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/workspace403Error' examples: Unauthorized: $ref: '#/components/examples/workspace403ErrorUnauthorized' getAllWorkspaceRoles: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getAllWorkspaceRoles' examples: Successful Response: $ref: '#/components/examples/getAllWorkspaceRoles' getWorkspace: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getWorkspace' examples: Successful Response: $ref: '#/components/examples/getWorkspace' Include SCIM IDs: $ref: '#/components/examples/getWorkspaceIncludeScimIds' Include Team ID and SCIM IDs: $ref: '#/components/examples/getWorkspaceIncludeTeamScimId' workspace404ErrorNotFound: description: Not Found content: application/json: schema: $ref: '#/components/schemas/workspace404Error' examples: Workspace Not Found: $ref: '#/components/examples/workspace404ErrorNotFound' updateWorkspace: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/updateWorkspaceResponse' examples: Workspace Updated: $ref: '#/components/examples/updateWorkspaceResponse' workspace403Error: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/commonErrorNameMessage' examples: Forbidden: $ref: '#/components/examples/workspace403Error' Cannot Convert to Public Workspace: $ref: '#/components/examples/workspace403ErrorToPublicForbidden' Cannot Convert From Public Workspace: $ref: '#/components/examples/workspace403ErrorFromPublicForbidden' instanceNotFoundWorkspace: description: Instance Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorNameMessage' examples: Instance Not Found: $ref: '#/components/examples/instanceNotFoundWorkspace' deleteWorkspace: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/deleteWorkspace' examples: Workspace Deleted: $ref: '#/components/examples/deleteWorkspace' workspace400Error: description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorNameMessage' examples: Workspace Not Found: $ref: '#/components/examples/workspace400Error' getWorkspaceActivityFeed: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getWorkspaceActivityFeed' examples: Successful Response: $ref: '#/components/examples/getWorkspaceActivityFeed' Filter by Element Type: $ref: '#/components/examples/getWorkspaceActivityFeedByElement' workspaceFeed400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Invalid Parameter: $ref: '#/components/examples/workspaceFeed400Error' Invalid User ID: $ref: '#/components/examples/workspaceFeed400ErrorUserId' workspaceCommon404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Workspace Not Found: $ref: '#/components/examples/workspaceCommon404Error' transferWorkspaceElementResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/transferWorkspaceElementResponse' examples: Transfer API: $ref: '#/components/examples/transferWorkspaceElementApiResponse' Transfer Collection: $ref: '#/components/examples/transferWorkspaceElementCollectionResponse' Transfer Flow: $ref: '#/components/examples/transferWorkspaceElementFlowResponse' Transfer Environment: $ref: '#/components/examples/transferWorkspaceElementEnvironmentResponse' Transfer Mock: $ref: '#/components/examples/transferWorkspaceElementMockResponse' Transfer Monitor: $ref: '#/components/examples/transferWorkspaceElementMonitorResponse' transferWorkspaceElement400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Cannot Transfer from Team to Personal: $ref: '#/components/examples/transferWorkspaceElement400ErrorTeamPersonalInvalid' Invalid type Property: $ref: '#/components/examples/transferWorkspaceElement400ErrorInvalidType' Missing id Property: $ref: '#/components/examples/transferWorkspaceElement400ErrorMissingId' Missing to Property: $ref: '#/components/examples/transferWorkspaceElement400ErrorMissingTo' Missing type Property: $ref: '#/components/examples/transferWorkspaceElement400ErrorMissingType' transferWorkspaceElement403Error: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Forbidden: $ref: '#/components/examples/common403Error' transferWorkspaceElement404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Workspace Not Found: $ref: '#/components/examples/workspaceCommon404Error' getWorkspaceGlobalVariables: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getWorkspaceGlobalVariables' examples: Successful Response: $ref: '#/components/examples/getWorkspaceGlobalVariables' globalVariables500Error: description: Internal Server Error content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetail' examples: Internal Server Error: $ref: '#/components/examples/globalVariables500Error' updateWorkspaceGlobalVariables: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/updateWorkspaceGlobalVariablesResponse' examples: Global Variables Updated: $ref: '#/components/examples/updateWorkspaceGlobalVariablesResponse' getWorkspaceRoles: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getWorkspaceRoles' examples: Successful Response: $ref: '#/components/examples/workspaceRoles' Return SCIM IDs: $ref: '#/components/examples/workspaceRolesScimIds' updateWorkspaceRoles: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/updateWorkspaceRolesResponse' examples: Update User Role: $ref: '#/components/examples/userRoleUpdated' Update Role with SCIM ID: $ref: '#/components/examples/userRoleUpdatedSCIMId' Update Role and Group with SCIM IDs: $ref: '#/components/examples/userRoleGroupUpdatedSCIMId' Add or Remove Workspace Group Role: $ref: '#/components/examples/workspaceRoles' Add and Remove Partner Roles: $ref: '#/components/examples/workspaceRolesAddRemovePartnerRole' workspaceRoles400Error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Invalid Parameter: $ref: '#/components/examples/workspaceRoles400Error' Invalid Role for Multi-Partner Workspace: $ref: '#/components/examples/workspaceRoles400ErrorInvalidMultiPartnerRole' Cannot Update Both Partner and User Roles: $ref: '#/components/examples/workspaceRoles400ErrorCannotUpdateUserPartnerRoles' Missing Operation in Partner Role Update: $ref: '#/components/examples/workspaceRoles400ErrorMissingOperationPartnerRoleUpdate' workspaceRoles422Error: description: Unprocessable Content content: application/json: schema: $ref: '#/components/schemas/workspaceRoles422Error' examples: Personal Workspace Roles Unsupported: $ref: '#/components/examples/workspaceRoles422Error' transferWorkspaceToTeamResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/transferWorkspaceToTeamResponse' examples: Successful Response: $ref: '#/components/examples/transferWorkspaceToTeamResponse' transferWorkspaceToTeam400Error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Invalid Request Body: $ref: '#/components/examples/transferWorkspaceToTeam400Error' transferWorkspaceToTeam401Error: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Unauthorized: $ref: '#/components/examples/common401Error' transferWorkspaceToTeam403Error: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Forbidden: $ref: '#/components/examples/common403ErrorWorkspaceAccess' transferWorkspaceToTeam404Error: description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Not Found: $ref: '#/components/examples/common404ErrorResourceNotFound' transferWorkspaceToTeam500Error: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Internal Server Error: $ref: '#/components/examples/common500ErrorServerErrorOccurred' getWorkspaceUpdates: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getWorkspaceUpdates' examples: Get Workspace Updates: $ref: '#/components/examples/getWorkspaceUpdates' Get Workspace Updates with Filters: $ref: '#/components/examples/getWorkspaceUpdatesFilters' workspaceUpdates400Error: description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Invalid Request Body: $ref: '#/components/examples/workspaceUpdates400ErrorBadRequestInvalidRequestBody' Missing category Property: $ref: '#/components/examples/workspaceUpdates400ErrorInvalidCategory' Invalid category Value: $ref: '#/components/examples/workspaceUpdates400ErrorInvalidUpdateCategory' workspaceUpdates401Error: description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' examples: GET, PATCH, DELETE Unauthorized: $ref: '#/components/examples/workspaceUpdates401ErrorGetPatchDeleteUnauthorized' GET All, POST Unauthorized: $ref: '#/components/examples/workspaceUpdates401ErrorGetAllPostUnauthorized' workspaceUpdates403Error: description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Create Update Forbidden: $ref: '#/components/examples/workspaceUpdates403ErrorCreateUpdateForbidden' Update Workspace Update Forbidden: $ref: '#/components/examples/workspaceUpdates403ErrorUpdateForbidden' View Update Forbidden: $ref: '#/components/examples/workspaceUpdates403ErrorViewUpdateForbidden' Delete Update Forbidden: $ref: '#/components/examples/workspaceUpdates403ErrorDeleteUpdateForbidden' workspaceUpdates404Error: description: Not Found content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Not Found: $ref: '#/components/examples/workspaceUpdates404ErrorEntityNotFound' Workspace Update Not Found: $ref: '#/components/examples/workspaceUpdates404ErrorWorkspaceUpdateNotFound' Workspace Not Found: $ref: '#/components/examples/workspaceUpdates404ErrorWorkspaceNotFound' createWorkspaceUpdateResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/workspaceUpdatePostPatchResponseData' example: value: id: 1 topic: API v1.0 released description: We've released the first version of our newest API! workspaceId: 1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 createdBy: 12345678 updatedBy: 12345678 createdAt: '2026-04-21T04:02:20.000Z' updatedAt: '2026-04-21T04:02:20.000Z' category: announcement isPinned: false relatedResources: - resource: collection resourceId: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 workspaceUpdates422Error: description: Unprocessable Content content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Unprocessable Content: $ref: '#/components/examples/workspaceUpdates422ErrorUnprocessableContent' getWorkspaceUpdate: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/workspaceUpdateData' examples: Successful Response: $ref: '#/components/examples/getWorkspaceUpdate' updateWorkspaceUpdateResponse: description: Successful Response content: application/json: schema: $ref: '#/components/schemas/workspaceUpdatePostPatchResponseData' examples: Successful Response: $ref: '#/components/examples/updateWorkspaceUpdateResponse' workspaceUpdates415Error: description: Unsupported Media Type content: application/problem+json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' examples: Unsupported Media Type: $ref: '#/components/examples/workspaceUpdates415ErrorUnsupportedMediaType' parameters: billingAccountId: name: accountId in: path required: true description: The account's ID. schema: $ref: '#/components/schemas/billingAccountId' billingAccountStatus: name: status in: query required: true description: The account's status. schema: $ref: '#/components/schemas/billingAccountStatus' analyticsResource: name: resource in: query required: true description: | Returns metrics and insights for API usage, success, and workspace/team trends in Postman: - `user` — Data related to individual user activities and engagement within Postman workspaces. - `team` — Team-level analytics, license consumption, and organizational trends. - `workspace` — Workspace-level activities, elements, and collaboration patterns. - `ai` — Analytics related to Agent Mode usage across workspaces, covering user activity, model usage, and credit consumption patterns. - `api_development` — API development activity metrics that include workspace counts, entity activity by type (collection, flow, mock, specification, sdk), and top entities. - `api_testing` — API testing metrics such as total test runs, functional test runs (Collection Runner), and performance test runs. - `api_production` — API production metrics, including monitor run activity and production flow execution activity. - `api_distribution` — API distribution metrics, such as active workspace counts across distribution channels. - `api_management` — API management metrics, such as workspace activity, active counts, trends, and top workspaces. schema: $ref: '#/components/schemas/analyticsResource' analyticsMetrics: name: metrics in: query required: true description: | Filters the response by only the given metrics. The metric must match the given `resource` value. For a list of metrics and their related `resource` value, call the GET `/analytics-metadata` endpoint. schema: $ref: '#/components/schemas/analyticsMetrics' analyticsView: name: view in: query description: | The view type for the analytics data: - `detailed` — Return extensive information. - `summary` — Return aggregated information. - `trend` — Return trend information over a duration. schema: $ref: '#/components/schemas/analyticsView' analyticsWorkspaceType: name: workspaceType in: query description: A comma-separated list of `internal`, `public`, and `partner` workspace types to filter the results by. schema: $ref: '#/components/schemas/analyticsWorkspaceType' analyticsUserId: name: userId in: query description: A comma-separated list of user IDs to filter the results by. Only pass this parameter when calling the `user_requests` metric for the `workspace` resource. schema: $ref: '#/components/schemas/analyticsUserId' analyticsDuration: name: duration in: query description: Filters the response by the given duration. schema: $ref: '#/components/schemas/analyticsDuration' analyticsRequestId: name: requestId in: query description: A comma-separated list of unique request IDs (`userId`-`requestId`) to filter the response by. Only pass this parameter when using the `user_requests` metric. schema: $ref: '#/components/schemas/analyticsRequestId' analyticsResponseStatus: name: responseStatus in: query description: A comma-separated list of HTTP response status codes to filter the results by. Accepts values `100` through `600`. Only pass this parameter when using the `user_requests` metric. schema: $ref: '#/components/schemas/analyticsResponseStatus' analyticsAttentionType: name: attentionType in: query description: A comma-separated list of issues types to filter the results by. Attention types provide details about issues users or partners are facing. Accepts the `high_non_200OK_rate_for_partner` and `no_success_on_tried_request` values. Only pass this parameter when using the `needs_attention` metric. schema: $ref: '#/components/schemas/analyticsAttentionType' analyticsPeriod: name: period in: query description: Filters results for a given period of time (as opposed to a range) for supported views. Use a YEAR-MONTH value for month filtering or YEAR-MONTH-DAY day filtering. schema: $ref: '#/components/schemas/analyticsPeriod' analyticsUserType: name: userType in: query description: Filters results by a specific user type for supported views. schema: $ref: '#/components/schemas/analyticsUserType' analyticsEntityType: name: entityType in: query description: The type of Postman entity to filter results by. schema: $ref: '#/components/schemas/analyticsEntityType' limitDefault100Max10000: name: limit in: query description: The maximum number of rows to return in the response. schema: $ref: '#/components/schemas/limitDefault100Max10000' offsetMax10000: name: offset in: query description: The zero-based offset of the first item to return. schema: $ref: '#/components/schemas/offsetMax10000' analyticsMetadataInclude: name: include in: query description: | A comma-separated list of the additional information to include in the response. Accepts the `parameters` and `response` values. When you pass this query parameter and its values, the response provides detailed information, including parameters and response schemas for the given metrics. schema: $ref: '#/components/schemas/analyticsMetadataInclude' analyticsMetadataResources: name: resources in: query description: A comma-separated list of resource types to filter the metrics by. Accepts the `user`, `workspace`, `team`, and `ai` values. schema: $ref: '#/components/schemas/analyticsMetadataResources' analyticsMetadataMetrics: name: metrics in: query description: | A comma-separated list of metrics values to use to filter the response. If you don't pass this query parameter, then the response returns all metadata for all available metrics. schema: $ref: '#/components/schemas/analyticsMetrics' discoveryServicesSource: name: discoverySource in: query description: | Filter results by the given discovery source type: - `api_gateway_app` — API Gateway integrations. - `insights_project` — Postman Insights. - `infra_watcher` — Cluster Watcher. - `public_api` — Services manually added using the POST `/api-catalog/discovery-services` endpoint. schema: $ref: '#/components/schemas/discoveryServicesSource' discoveryServicesStatus: name: status in: query description: A comma-separated list of statuses to filter the results by. Accepts the `discovered`, `integrated`, and `archived` values. schema: $ref: '#/components/schemas/discoveryServicesStatus' discoveryServicesSearch: name: search in: query description: Filter results by the given value that match a service's name. Matching is not case-sensitive. schema: $ref: '#/components/schemas/discoveryServicesSearch' limitDefault20: name: limit in: query description: The maximum number of rows to return in the response, up to a maximum value of 100. Any value greater than 100 returns a 400 Bad Request response. schema: $ref: '#/components/schemas/limitDefault20' cursor: name: cursor in: query description: The pointer to the first record of the set of paginated results. To view the next response, use the `nextCursor` value for this parameter. schema: $ref: '#/components/schemas/cursor' discoveryServiceId: name: serviceId in: path required: true description: The discovered service's ID. schema: $ref: '#/components/schemas/serviceId' apiCatalogServiceSystemEnvironmentId: name: systemEnvironmentId in: query required: true description: The system environment's ID. schema: $ref: '#/components/schemas/systemEnvironmentId' apiCatalogServiceNameFilter: name: name in: query description: Filter results to the given the service name. This is case-insensitive. schema: $ref: '#/components/schemas/apiCatalogServiceNameFilter' apiCatalogServiceTagsFilter: name: tags in: query description: A comma-separated list of tag names to filter by. schema: $ref: '#/components/schemas/apiCatalogServiceTagsFilter' apiCatalogServiceGovernanceGroupIdFilter: name: governanceGroupId in: query description: Filter results to only services that belong to the given governance group ID. schema: $ref: '#/components/schemas/apiCatalogServiceGovernanceGroupIdFilter' apiCatalogServiceId: name: serviceId in: path required: true description: The service's ID. schema: $ref: '#/components/schemas/serviceId' apiCatalogServiceHttpMethodFilter: name: httpMethods in: query description: A.comma-separated list of HTTP methods to filter the results by. schema: $ref: '#/components/schemas/apiCatalogServiceHttpMethodFilter' apiCatalogServiceHostsFilter: name: hosts in: query description: A comma-separated list of hostnames to filter the results by. schema: $ref: '#/components/schemas/apiCatalogServiceHostsFilter' apiCatalogServiceResponseCodeFilter: name: responseCodes in: query description: A comma-separated list of HTTP status codes to filter the results by. schema: $ref: '#/components/schemas/apiCatalogServiceResponseCodeFilter' apiCatalogServiceSearchFilter: name: search in: query description: Filter results to the search filter given on the endpoint's path. schema: $ref: '#/components/schemas/apiCatalogServiceSearchFilter' apiCatalogServiceSortEndpointsFilter: name: sort in: query description: Sort the results in field:direction order format. Accepts the `count`, `endpoint`, `p95LatencyMs`, and `errorRate` fields. Supports the `asc` and `desc` directions. schema: $ref: '#/components/schemas/apiCatalogServiceSortEndpointsFilter' apiCatalogServiceCollectionIdFilter: name: collectionId in: query description: Filter results to only the given collection ID's runs. schema: $ref: '#/components/schemas/collectionUid' apiCatalogServiceSortMonitorRun: name: sort in: query description: Sort the results in field:direction order format. Accepts the `timestamp`, `duration`, and `failedAssertions` fields. Supports the `asc` and `desc` directions. schema: $ref: '#/components/schemas/apiCatalogServiceSortMonitorRun' apiCatalogServiceEnvironmentIdFilter: name: environmentId in: query description: Filter results to only the given environment ID runs. schema: $ref: '#/components/schemas/environmentId' apiCatalogServiceStatusFilter: name: status in: query description: Filter results by run status. schema: $ref: '#/components/schemas/apiCatalogServiceStatusFilter' apiCatalogServiceSpecIdFilter: name: specId in: query description: Filter results to the given API specification ID. schema: $ref: '#/components/schemas/specId' apiCatalogServiceSpecLintSeverityFilter: name: severity in: query description: Filter results to runs with issues at or above the given severity threshold. Higher severities are always included. schema: $ref: '#/components/schemas/apiCatalogServiceSpecLintSeverityFilter' apiCatalogServiceSpecLintStatusFilter: name: status in: query description: Filter results to the given spec lint outcome. schema: $ref: '#/components/schemas/apiCatalogServiceStatusFilter' apiCatalogServiceSortSpecLintFilter: name: sort in: query description: Sort the results in field:direction order format. Accepts the `timestamp` and `errorCount` fields. Supports the `asc` and `desc` directions. schema: $ref: '#/components/schemas/apiCatalogServiceSortSpecLintFilter' apiCatalogServiceBranchFilter: name: branch in: query description: Filter results by the given Git branch name. schema: $ref: '#/components/schemas/apiCatalogServiceBranchFilter' apiCatalogServiceWorkflowNameFilter: name: workflowName in: query description: Filter results by the given CI workflow name. schema: $ref: '#/components/schemas/apiCatalogServiceWorkflowNameFilter' apiCatalogActorFilter: name: actor in: query description: Filter results by the given CI user that triggered the run. schema: $ref: '#/components/schemas/apiCatalogServiceActorFilter' apiCatalogServiceRepoNameFilter: name: repoName in: query description: Filter results by the given repository name. schema: $ref: '#/components/schemas/apiCatalogServiceRepoNameFilter' apiCatalogServiceRepoOwnerFilter: name: repoOwner in: query description: Filter results by the given repository owner. schema: $ref: '#/components/schemas/apiCatalogServiceRepoOwnerFilter' apiCatalogServiceSortCiFilter: name: sort in: query description: Sort the results in field:direction order format. Accepts the `timestamp` and `duration` fields. Supports the `asc` and `desc` directions. schema: $ref: '#/components/schemas/apiCatalogServiceSortCiFilter' systemEnvironmentProductionFilter: name: isProduction in: query description: If true, filters the response results to return only system environments marked as production. schema: $ref: '#/components/schemas/systemEnvironmentProductionFilter' systemEnvironmentId: name: systemEnvironmentId in: path required: true description: The system environment's ID. schema: $ref: '#/components/schemas/systemEnvironmentId' systemEnvironmentWorkspaceId: name: workspaceId in: query description: The workspace's ID to which the environments in the association belong to. schema: $ref: '#/components/schemas/systemEnvironmentWorkspaceId' systemEnvironmentAllowPartial: name: allowPartial in: query description: If false, the system only adds associations when there are no status errors. If true, the system skips any ineligible associations and adds eligible associations. schema: $ref: '#/components/schemas/systemEnvironmentAllowPartial' workspaceIdQueryTrue: name: workspaceId in: query required: true description: The workspace's ID. schema: $ref: '#/components/schemas/workspaceId' v10Accept: name: Accept in: header required: true description: The `application/vnd.api.v10+json` request header required to use the endpoint. schema: $ref: '#/components/schemas/v10Accept' createdBy: name: createdBy in: query description: Return only results created by the given user ID. schema: $ref: '#/components/schemas/createdBy' apiDescription: name: description in: query description: Return only APIs whose description includes the given value. Matching is not case-sensitive. schema: $ref: '#/components/schemas/apiDescription' limit: name: limit in: query description: The maximum number of rows to return in the response. schema: $ref: '#/components/schemas/limit' apiId: name: apiId in: path required: true description: The API's ID. schema: $ref: '#/components/schemas/apiId' apiInclude: name: include in: query description: | An array that contains additional resources to include in the response. Use this parameter to query for element links to the API, such as collections and schemas: - `collections` — Query for linked Postman collections. - `versions` — Query for linked versions. - `schemas` — Query for linked schemas. - `gitInfo` — Query for information about the API's git-linked repository. This query only returns the linked repository and folder locations of the files. It does not return `collections` or `schemas` information. **Note:** API viewers can only use the `versions` option. schema: $ref: '#/components/schemas/apiInclude' collectionIdApi: name: collectionId in: path required: true description: The collection's unique ID. schema: $ref: '#/components/schemas/collectionIdApi' apiVersionQuery: name: versionId in: query description: The API's version ID. This is a required parameter for API viewers. schema: $ref: '#/components/schemas/apiVersionId' commentId: name: commentId in: path required: true description: The comment's ID. schema: $ref: '#/components/schemas/commentId' apiSchemaId: name: schemaId in: path required: true description: The API schema's ID. schema: $ref: '#/components/schemas/apiSchemaId' apiSchemaOutput: name: bundled in: query description: If true, return the schema in a bundled format. schema: $ref: '#/components/schemas/apiSchemaOutput' file-path: name: file-path in: path required: true description: The path to the schema file. schema: $ref: '#/components/schemas/file-path' apiTaskId: name: taskId in: path required: true description: The task's ID. schema: $ref: '#/components/schemas/apiTaskId' apiVersionId: name: versionId in: path required: true description: The API's version ID. schema: $ref: '#/components/schemas/apiVersionId' auditLogsUserIdQuery: name: userId in: query description: Return only results that match the given user ID. schema: $ref: '#/components/schemas/auditLogsUserIdQuery' auditLogsActionQuery: name: action in: query description: Filter results by an audit log action. schema: $ref: '#/components/schemas/auditLogsActionQuery' auditLogsSinceQuery: name: since in: query description: Return logs created after the given time, in `YYYY-MM-DD` format. schema: $ref: '#/components/schemas/sinceDateQuery' auditLogsUntilQuery: name: until in: query description: Return logs created before the given time, in `YYYY-MM-DD` format. schema: $ref: '#/components/schemas/untilDateQuery' auditLogsLimitQuery: name: limit in: query description: The maximum number of audit events to return at once. schema: $ref: '#/components/schemas/auditLogsLimitQuery' auditLogsOrderBy: name: orderBy in: query description: Return the records in ascending (`asc`) or descending (`desc`) order. schema: $ref: '#/components/schemas/ascDescDefaultDesc' auditLogsOrderByDeprecated: name: order_by in: query deprecated: true description: Return the records in ascending (`asc`) or descending (`desc`) order. schema: $ref: '#/components/schemas/ascDescDefaultDesc' collectionUidQuery: name: collectionId in: query description: Filter the results by a collection's unique ID. schema: $ref: '#/components/schemas/collectionUidQuery' collectionAccessKeyId: name: keyId in: path required: true description: The collection access key's ID. schema: $ref: '#/components/schemas/collectionAccessKeyId' collectionForkTaskId: name: taskId in: path required: true description: The task's ID. schema: $ref: '#/components/schemas/collectionForkTaskId' workspaceQuery: name: workspace in: query description: The workspace's ID. schema: $ref: '#/components/schemas/workspaceId' collectionNameQuery: name: name in: query description: Filter results by collections whose name exactly matches the given value. Partial or substring matches are not supported. schema: $ref: '#/components/schemas/collectionNameQuery' limitNoDefault: name: limit in: query description: The maximum number of rows to return in the response. schema: $ref: '#/components/schemas/limitNoDefault' offsetNoDefault: name: offset in: query description: The zero-based offset of the first item to return. schema: $ref: '#/components/schemas/offsetNoDefault' workspaceQueryTrue: name: workspace in: query required: true description: The workspace's ID. schema: $ref: '#/components/schemas/workspaceId' createdAtSort: name: direction in: query description: Sort the results by creation date in ascending (`asc`) or descending (`desc`) order. schema: $ref: '#/components/schemas/ascDesc' collectionId: name: collectionId in: path required: true description: The collection's ID. schema: $ref: '#/components/schemas/collectionId' forkWorkspaceQuery: name: workspace in: query required: true description: The workspace ID in which to create the fork. schema: $ref: '#/components/schemas/workspaceId' collectionAccessKeyQuery: name: access_key in: query description: A collection's read-only access key. Using this query parameter does not require an API key to call the endpoint. schema: $ref: '#/components/schemas/collectionAccessKeyQuery' collectionModelQuery: name: model in: query description: Return a list of only the collection's root-level request (`rootLevelRequests`) and folder (`rootLevelFolders`) IDs instead of the full collection element data. schema: $ref: '#/components/schemas/collectionModelQuery' Prefer: name: Prefer in: header description: The `respond-async` header to perform the update asynchronously. schema: $ref: '#/components/schemas/Prefer' collectionUid: name: collectionId in: path required: true description: The collection's unique ID. schema: $ref: '#/components/schemas/collectionUid' collectionFolderUid: name: folderId in: path required: true description: The folder's unique ID. schema: $ref: '#/components/schemas/collectionFolderUid' collectionUniqueId: name: collectionUid in: path required: true description: The collection's unique ID. schema: $ref: '#/components/schemas/collectionUid' elementTypeSpec: name: elementType in: path required: true description: The `spec` value. schema: $ref: '#/components/schemas/elementTypeSpec' forkedCollectionId: name: collectionId in: path required: true description: The forked collection's ID. schema: $ref: '#/components/schemas/collectionId' collectionRequestFolderIdQuery: name: folder in: query description: The folder ID in which to create the request. By default, the system creates the request at the collection level. schema: $ref: '#/components/schemas/collectionFolderId' collectionRequestUid: name: requestId in: path required: true description: The request's unique ID. schema: $ref: '#/components/schemas/collectionRequestUid' collectionResponseParentRequestId: name: request in: query required: true description: The parent request's ID. schema: $ref: '#/components/schemas/collectionRequestId' collectionResponseUid: name: responseId in: path required: true description: The response's unique ID. schema: $ref: '#/components/schemas/collectionResponseUid' specIdQuery: name: specId in: query required: true description: The spec's ID. schema: $ref: '#/components/schemas/specId' collectionFolderId: name: folderId in: path required: true description: The folder's ID. schema: $ref: '#/components/schemas/collectionFolderId' collectionItemsIdQuery: name: ids in: query description: If true, returns only properties that contain ID values in the response. schema: $ref: '#/components/schemas/booleanQuery' collectionItemsUidFormatQuery: name: uid in: query description: If true, returns all IDs in UID format (`userId`-`id`). schema: $ref: '#/components/schemas/booleanQuery' collectionItemsPopulateQuery: name: populate in: query description: If true, returns all of the collection item's contents. schema: $ref: '#/components/schemas/booleanQuery' collectionRequestId: name: requestId in: path required: true description: The request's ID. schema: $ref: '#/components/schemas/collectionRequestId' collectionResponseId: name: responseId in: path required: true description: The response's ID. schema: $ref: '#/components/schemas/collectionResponseId' collectionTransformFormat: name: format in: query description: Return the OpenAPI definition in the given format. schema: $ref: '#/components/schemas/collectionTransformFormat' taskUid: name: taskId in: path required: true description: The task's unique ID. schema: $ref: '#/components/schemas/taskUid' taskId: name: taskId in: path required: true description: The task's ID. schema: $ref: '#/components/schemas/taskId' threadId: name: threadId in: path required: true description: The comment's thread ID. schema: $ref: '#/components/schemas/threadId' componentType: name: type in: query description: Filter results by component type. schema: $ref: '#/components/schemas/componentType' componentStatus: name: status in: query description: Filter results by the component's status. schema: $ref: '#/components/schemas/componentStatus' componentHasVersions: name: hasVersions in: query description: If true, return only components with published versions. schema: $ref: '#/components/schemas/componentHasVersions' componentIncludeFields: name: include in: query description: A comma-separated list of additional fields to include. Accepts the `hasVersions`, `latestVersion`, `latestVersion.content` values. schema: $ref: '#/components/schemas/componentIncludeFields' componentExpandLatestVersion: name: expand in: query description: A comma-separated list of fields to expand. Accepts the `latestVersion` value. schema: $ref: '#/components/schemas/componentExpandLatestVersion' componentId: name: componentId in: path required: true description: The component's ID. schema: $ref: '#/components/schemas/componentId' componentLibraryInclude: name: include in: query description: A comma-separated list of additional fields to include. Accepts the `content` value. schema: $ref: '#/components/schemas/componentLibraryInclude' componentVersionId: name: versionId in: path required: true description: The component version's ID. schema: $ref: '#/components/schemas/componentVersionId' contextGraphAskId: name: askId in: path required: true description: The ask's ID. schema: $ref: '#/components/schemas/contextGraphAskId' limit-2: name: limit in: query description: The maximum number of results to return per page. schema: $ref: '#/components/schemas/limitDefault10Max100' customFunctionId: name: customFunctionId in: path required: true description: The custom function's ID. schema: $ref: '#/components/schemas/customFunctionId' apiGovernanceInclude: name: include in: query description: The related fields to include in the response. Currently only `content` is supported. Omit this parameter to receive only the resource's metadata. schema: $ref: '#/components/schemas/apiGovernanceInclude' include: name: include in: query description: | The additional fields to be included as a part of the request: - `meta.total` — Include the total records found in the `meta` response object. schema: $ref: '#/components/schemas/include' sinceUrlEncode: name: since in: query description: Return only results created since the given time, in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be later than the `until` value. To use `time-numoffset` format, you must use `%2B` URL-encoding for the `+` character. schema: $ref: '#/components/schemas/sinceDateTime' untilUrlEncode: name: until in: query description: Return only results created until this given time, in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be earlier than the `since` value. To use `time-numoffset` format, you must use `%2B` URL-encoding for the `+` character. schema: $ref: '#/components/schemas/untilDateTime' secretId: name: secretId in: path required: true description: The secret's ID. schema: $ref: '#/components/schemas/secretId' resourceType: name: resourceType in: query description: Return only results that match the given resource type. schema: $ref: '#/components/schemas/resourceType' elementType: name: elementType in: path required: true description: The element to filter results by. schema: $ref: '#/components/schemas/elementType' elementId: name: elementId in: path required: true description: The element's ID. schema: $ref: '#/components/schemas/elementId' environmentId: name: environmentId in: path required: true description: The environment's ID. schema: $ref: '#/components/schemas/environmentId' environmentUid: name: environmentId in: path required: true description: The environment's unique ID. schema: $ref: '#/components/schemas/environmentUid' directionQuery: name: direction in: query description: Sort results in ascending (`asc`) or descending (`desc`) order. schema: $ref: '#/components/schemas/ascDesc' sortByCreatedAt: name: sort in: query description: Sort the results by the date and time of creation. schema: $ref: '#/components/schemas/sortByCreatedAt' destinationEnvironmentUid: name: environmentUid in: path required: true description: The destination environment's unique ID. schema: $ref: '#/components/schemas/environmentUid' governanceGroupId: name: groupId in: path required: true description: The governance group's ID. schema: $ref: '#/components/schemas/governanceGroupId' groupId: name: groupId in: path required: true description: The group's ID. schema: $ref: '#/components/schemas/groupId' teamIdResultsQuery: name: teamId in: query description: Return only results that belong to the given team ID. schema: $ref: '#/components/schemas/teamIdResultsQuery' workspaceResultsQuery: name: workspace in: query description: Return only results found in the given workspace ID. schema: $ref: '#/components/schemas/workspaceId' mockId: name: mockId in: path required: true description: The mock's ID. schema: $ref: '#/components/schemas/mockId' limitDefault100: name: limit in: query description: The maximum number of rows to return in the response. schema: $ref: '#/components/schemas/limitDefault100' until: name: until in: query description: Return only results created until this given time, in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be earlier than the `since` value. schema: $ref: '#/components/schemas/untilDateTime' since: name: since in: query description: Return only results created since the given time, in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be later than the `until` value. schema: $ref: '#/components/schemas/sinceDateTime' mockResponseStatusCode: name: responseStatusCode in: query description: Return only call logs that match the given HTTP response status code. schema: $ref: '#/components/schemas/mockResponseStatusCode' mockResponseType: name: responseType in: query description: Return only call logs that match the given response type. Matching is not case-sensitive. schema: $ref: '#/components/schemas/mockResponseType' mockRequestMethod: name: requestMethod in: query description: Return only call logs that match the given HTTP method. Matching is not case-sensitive. schema: $ref: '#/components/schemas/mockRequestMethod' mockRequestPath: name: requestPath in: query description: Return only call logs that match the given request path. Matching is not case-sensitive. schema: $ref: '#/components/schemas/mockRequestPath' mockSortServedAt: name: sort in: query description: Sort the results by the given value. If you use this query parameter, you must also use the `direction` parameter. schema: $ref: '#/components/schemas/mockSortServedAt' direction: name: direction in: query description: Sort in ascending (`asc`) or descending (`desc`) order. Matching is not case-sensitive. If you use this query parameter, you must also use the `sort` parameter. schema: $ref: '#/components/schemas/ascDesc' mockInclude: name: include in: query description: Include call log records with header and body data. This query parameter accepts the `request.headers`, `request.body`, `response.headers`, and `response.body` values. For multiple include types, comma-separate each value. schema: $ref: '#/components/schemas/mockInclude' serverResponseId: name: serverResponseId in: path required: true description: The server response's ID. schema: $ref: '#/components/schemas/serverResponseId' active: name: active in: query description: If true, return only active monitors. schema: $ref: '#/components/schemas/active' owner: name: owner in: query description: Return only results that belong to the given user ID. schema: $ref: '#/components/schemas/owner' collectionUidQuery-2: name: collectionUid in: query description: Filter the results by a collection's unique ID. schema: $ref: '#/components/schemas/collectionUidQuery' environmentUidQuery: name: environmentUid in: query description: Filter the results by an environment's unique ID. schema: $ref: '#/components/schemas/environmentUid' limitDefault25: name: limit in: query description: The maximum number of rows to return in the response, up to a maximum value of 25. Any value greater than 25 returns a 400 Bad Request response. schema: $ref: '#/components/schemas/limitDefault25' monitorId: name: monitorId in: path required: true description: The monitor's ID. schema: $ref: '#/components/schemas/monitorId' async: name: async in: query description: If true, runs the monitor asynchronously from the created monitor run task. By default, the server will not respond until the task finishes (`false`). schema: $ref: '#/components/schemas/async' elementTypeQuery: name: type in: query description: The `workspace` value. schema: $ref: '#/components/schemas/elementTypeQuery' panElementName: name: name in: query description: Return only workspaces whose name includes the given value. Matching is not case-sensitive. schema: $ref: '#/components/schemas/panElementName' panSummary: name: summary in: query description: Return only workspaces whose summary includes the given value. Matching is not case-sensitive. schema: $ref: '#/components/schemas/panSummary' panElementDescription: name: description in: query description: Return only workspaces whose description includes the given value. Matching is not case-sensitive. schema: $ref: '#/components/schemas/panElementDescription' panAddedBy: name: addedBy in: query description: Return only workspaces published by the given user ID. schema: $ref: '#/components/schemas/panAddedBy' sortCreatedUpdatedAt: name: sort in: query description: Sort the results by the given value. If you use this query parameter, you must also use the `direction` parameter. schema: $ref: '#/components/schemas/sortCreatedUpdatedAt' offset: name: offset in: query description: The zero-based offset of the first item to return. schema: $ref: '#/components/schemas/offset' limitDefault1000: name: limit in: query description: The maximum number of results to return. If the value exceeds the maximum value of `1000`, then the system uses the `1000` value. schema: $ref: '#/components/schemas/limitDefault1000' panParentFolderId: name: parentFolderId deprecated: true in: query description: This parameter is deprecated. schema: $ref: '#/components/schemas/panParentFolderId' workspaceId: name: workspaceId in: path required: true description: The workspace's ID. schema: $ref: '#/components/schemas/workspaceId' panRequestedBy: name: requestedBy in: query description: Return a user's requests by their user ID. schema: $ref: '#/components/schemas/panRequestedBy' panRequestStatus: name: status in: query description: Filter by the request status. schema: $ref: '#/components/schemas/panRequestStatus' panRequestId: name: requestId in: path required: true description: The request's ID. schema: $ref: '#/components/schemas/panRequestId' limitDefault100Max100: name: limit in: query description: The maximum number of packages to return. schema: $ref: '#/components/schemas/limitDefault100Max100' packageId: name: packageId in: path required: true description: The package's ID. schema: $ref: '#/components/schemas/packageId' pullRequestId: name: pullRequestId in: path required: true description: The pull request's ID. schema: $ref: '#/components/schemas/pullRequestId' runnerId: name: runnerId in: path required: true description: The runner's ID. schema: $ref: '#/components/schemas/runnerId' rulesetId: name: rulesetId in: path required: true description: The ruleset's ID. schema: $ref: '#/components/schemas/rulesetId' targetTypeQuery: name: targetType in: query required: true description: The assignment target type. Currently only `governance_group` is supported. schema: $ref: '#/components/schemas/targetType' targetIdQuery: name: targetId in: query required: true description: The target governance group's ID. schema: $ref: '#/components/schemas/governanceGroupId' tagsSlug: name: slug in: path required: true description: The tag's ID within a team or individual (non-team) user scope. schema: $ref: '#/components/schemas/tagsSlug' tagsEntitiesLimit: name: limit in: query description: The maximum number of tagged elements to return in a single call. schema: $ref: '#/components/schemas/tagsEntitiesLimit' tagsEntitiesDirection: name: direction in: query description: The ascending (`asc`) or descending (`desc`) order to sort the results by, based on the time of the entity's tagging. schema: $ref: '#/components/schemas/ascDescDefaultDesc' tagsCursor: name: cursor in: query description: The cursor to get the next set of results in the paginated response. If you pass an invalid value, the API only returns the first set of results. schema: $ref: '#/components/schemas/tagsCursor' tagsEntityType: name: entityType in: query description: Filter results for the given entity type. schema: $ref: '#/components/schemas/tagsEntityType' startIndex: name: startIndex in: query description: The index entry by which to begin the list of returned results. Must be a value of `1` or greater. schema: $ref: '#/components/schemas/startIndex' count: name: count in: query description: Limit the number of results returned in a single response. schema: $ref: '#/components/schemas/count' scimGroupFilter: name: filter in: query description: | Filter results by a specific word or phrase. This query parameter only supports the `displayName` filter and has the following requirements: - Filter values are case-sensitive. - Special characters and spaces must be URL encoded. schema: $ref: '#/components/schemas/scimGroupFilter' scimGroupId: name: groupId in: path required: true description: The group's ID. schema: $ref: '#/components/schemas/scimId' scimUserFilter: name: filter in: query description: | Filter results by a specific word or phrase. This query parameter accepts the following: - `userName` — Filter values are case-sensitive, and special characters and spaces must be URL encoded. - `active` — Return only users who are active (`true`) or inactive (`false`). schema: $ref: '#/components/schemas/scimUserFilter' examples: Filter: value: userName eq "taylor%2Dlee@example.com" Filter with Encoding: value: userName eq "taylor%2Dlee%2Btest%40example.com" Filter Active Users: value: active eq "true" Filter Inactive Users: value: active eq "false" scimUserId: name: userId in: path required: true description: The user's SCIM ID. schema: $ref: '#/components/schemas/scimId' sdkWorkspaceId: name: workspaceId in: query required: true description: The ID of the workspace that contains the SDK. schema: $ref: '#/components/schemas/workspaceId' sdkIds: name: sdkIds in: query style: form explode: false description: A comma-separated list of SDK IDs to return in the response. If you pass this query parameter with other filters, the other filters are ignored. schema: type: array maxItems: 100 items: $ref: '#/components/schemas/sdkId' example: - 9c4e7d1a-2b3c-4f5e-8a9b-1c2d3e4f5a6b - 4b8c2d3e-5f6a-7b8c-9d0e-1f2a3b4c5d6e sdkBuildStatusFilter: name: buildStatus in: query description: Filter results by build status. schema: $ref: '#/components/schemas/sdkBuildStatus' sdkLanguageFilter: name: language in: query description: Filter results by SDK language. schema: $ref: '#/components/schemas/sdkLanguage' sdkSourceId: name: sourceId in: query description: Filter results by the originating Postman Collection or specification ID. schema: $ref: '#/components/schemas/sdkSourceId' sdkId: name: sdkId in: path required: true description: The SDK's ID. schema: $ref: '#/components/schemas/sdkId' sdkGitConnectionWorkspaceId: name: workspaceId in: query required: true description: The ID of the workspace that owns the source entities. schema: $ref: '#/components/schemas/workspaceId' sdkGitConnectionStatusFilter: name: status in: query description: Filter results by connection status. schema: $ref: '#/components/schemas/sdkGitConnectionStatus' sdkGitConnectionRepositoryUrl: name: repositoryUrl in: query description: Filter results by the canonical URL of the target Git repository. schema: $ref: '#/components/schemas/sdkGitConnectionRepositoryUrl' sdkGitConnectionId: name: sdkGitConnectionId in: path required: true description: The Git connection's ID. schema: $ref: '#/components/schemas/sdkGitConnectionId' sdkGitConnectionPRStatusFilter: name: status in: query description: Filter results by pull request status. schema: $ref: '#/components/schemas/sdkGitConnectionPRStatus' limitDefault10Max25: name: limit in: query description: The maximum number of results to return per page. schema: $ref: '#/components/schemas/limitDefault10Max25' specId: name: specId in: path required: true description: The spec's ID. schema: $ref: '#/components/schemas/specId' filePath: name: filePath in: path required: true description: The path to the file. schema: $ref: '#/components/schemas/filePath' elementTypeCollection: name: elementType in: path required: true description: The `collection` element type. schema: $ref: '#/components/schemas/elementTypeCollection' collectionUniqueIdQuery: name: collectionUid in: query required: true description: The collection's unique ID. schema: $ref: '#/components/schemas/collectionUid' tagId: name: tagId in: path required: true description: The version tag's ID. schema: $ref: '#/components/schemas/tagId' identifierType: name: identifierType in: header description: Use SCIM user and group IDs instead of Postman user IDs. schema: $ref: '#/components/schemas/identifierType' limitDefault50: name: limit in: query description: The maximum number of rows to return in the response. schema: $ref: '#/components/schemas/limitDefault50' teamSettingsQuery: name: settings in: query description: If true, returns team settings in the response. schema: $ref: '#/components/schemas/teamSettingsQuery' userRolesQuery: name: userRoles in: query description: If true, returns the team's assigned user roles in the response. schema: $ref: '#/components/schemas/userRolesQuery' teamId: name: teamId in: path required: true description: The team's ID. schema: $ref: '#/components/schemas/teamId' teamsInclude: name: include in: query description: | Include additional information in the request's response: - `members` — Include all users and groups, including groups that represent other teams or the entire organization, with access to the team's entities. This includes team managers, members, and persons invited to collaborate as guests. - `userRoles` — Include all the team's user roles in the response. schema: $ref: '#/components/schemas/teamsInclude' accessRequestId: name: requestId in: path required: true description: The access request's ID. schema: $ref: '#/components/schemas/accessRequestId' groupId-2: name: groupId in: query description: Filter results by the given [group](https://learning.postman.com/docs/collaborating-in-postman/user-groups/) ID. To get group IDs, use the GET `/groups` endpoint. schema: $ref: '#/components/schemas/groupId' userId: name: userId in: path required: true description: The user's ID. schema: $ref: '#/components/schemas/userId' workspaceTypeQuery: name: type in: query description: The type of workspace to filter the response by. schema: $ref: '#/components/schemas/workspaceTypeQuery' workspaceCreatedBy: name: createdBy in: query description: Return only workspaces created by a specific user ID. For multiple users, pass this value as a comma-separated list of user IDs. The response only returns workspaces that you have access to. schema: $ref: '#/components/schemas/workspaceCreatedBy' workspacesIncludeQuery: name: include in: query description: | Include the following information in the endpoint's response: - `mocks:deactivated` — Include all deactivated mock servers in the response. - `scim` — Return the SCIM user IDs of the workspace creator and who last modified it. schema: $ref: '#/components/schemas/workspacesIncludeQuery' workspaceElementTypeQuery: name: elementType in: query description: Filter results to return the workspace where the given element type is located. If you pass this query parameter, you must also pass the `elementId` query parameter. schema: $ref: '#/components/schemas/workspaceElementTypeQuery' workspaceElementIdQuery: name: elementId in: query description: Filter results to return the workspace where the given element's ID is located. When filtering by collection, you must use the collection's unique ID (`userId`-`collection`). If you pass this query parameter, you must also pass the `elementType` query parameter. schema: $ref: '#/components/schemas/workspaceElementIdQuery' limitMax100: name: limit in: query description: The maximum number of rows to return in the response, up to a maximum value of 100. Any value greater than 100 returns a 400 Bad Request response. schema: $ref: '#/components/schemas/limitMax100' workspaceIncludeQuery: name: include in: query description: | A comma-separated list of values to include in the endpoint's response: - `scim` — Return the SCIM user IDs of the workspace creator and who last modified it. - `team` — Return the workspace's team ID. Returns a null value if the workspace isn't associated with a team. - `mocks:deactivated` — Include all deactivated mock servers in the response. schema: $ref: '#/components/schemas/workspaceIncludeQuery' userIdQuery: in: query name: userId description: Filter results by the given user ID. schema: $ref: '#/components/schemas/userId-2' elementType-2: in: query name: elementType description: A comma-separated list of elements to filter the results by. schema: $ref: '#/components/schemas/elementType-3' limitDefault15: name: limit in: query description: The maximum number of rows to return in the response. schema: $ref: '#/components/schemas/limitDefault15' workspaceIncludeScimQuery: name: include in: query description: | Include the following information in the endpoint's response: - `scim` — Return IDs as SCIM user and group IDs. schema: $ref: '#/components/schemas/workspaceIncludeScimQuery' identifierType-2: name: identifierType in: header description: Use SCIM user IDs instead of Postman user IDs. schema: $ref: '#/components/schemas/identifierType' workspaceUpdateCategory: name: category in: query description: A comma-separated list of categories to filter the results by. Accepts `improvement`, `bug_fix`, `new_feature`, `breaking_change`, `announcement`. schema: $ref: '#/components/schemas/workspaceUpdateCategory' workspaceUpdateId: name: updateId in: path required: true description: The workspace update's ID. schema: $ref: '#/components/schemas/workspaceUpdateId' contentTypeMerge-PatchHeaderHeader: in: header name: Content-Type description: The `application/merge-patch+json` header. required: true schema: $ref: '#/components/schemas/contentTypeMerge-PatchHeader' requestBodies: postApiCatalogDiscoveryServices: content: application/json: schema: $ref: '#/components/schemas/postApiCatalogDiscoveryServices' examples: Add a Discovered Service: $ref: '#/components/examples/postApiCatalogDiscoveryServicesAddService' Add a Fully-Populated Service: $ref: '#/components/examples/postApiCatalogDiscoveryServicesAddFullyPopulatedService' Add Service with an OpenAPI Specification: $ref: '#/components/examples/postApiCatalogDiscoveryServicesAddServiceWithOas' Add Multiple Services: $ref: '#/components/examples/postApiCatalogDiscoveryServicesAddMultipleServices' Add Multiple Services with OpenAPI Specifications and Endpoints: $ref: '#/components/examples/postApiCatalogDiscoveryServicesAddServicesWithSpecsEndpoints' createApiCatalogSystemEnvironment: content: application/json: schema: $ref: '#/components/schemas/createApiCatalogSystemEnvironment' examples: Create System Environment: $ref: '#/components/examples/createApiCatalogSystemEnvironment' updateApiCatalogSystemEnvironment: content: application/json: schema: $ref: '#/components/schemas/updateApiCatalogSystemEnvironment' examples: Update a System Environment: $ref: '#/components/examples/updateApiCatalogSystemEnvironment' addApiCatalogSystemEnvironmentAssociations: content: application/json: schema: $ref: '#/components/schemas/addApiCatalogSystemEnvironmentAssociations' examples: Add System Environment Associations: $ref: '#/components/examples/addApiCatalogSystemEnvironmentAssociations' removeApiCatalogSystemEnvironmentAssociations: content: application/json: schema: $ref: '#/components/schemas/removeApiCatalogSystemEnvironmentAssociations' examples: Remove Associations: $ref: '#/components/examples/removeApiCatalogSystemEnvironmentAssociations' createUpdateApi: content: application/json: schema: $ref: '#/components/schemas/createUpdateApi' examples: Create or Update API: $ref: '#/components/examples/createUpdateApi' addApiCollection: content: application/json: schema: anyOf: - $ref: '#/components/schemas/copyCollectionToApi' - $ref: '#/components/schemas/createApiCollection' - $ref: '#/components/schemas/generateApiFromSchema' examples: Copy a Collection: $ref: '#/components/examples/addApiCollectionCopy' Generate a Collection from Schema: $ref: '#/components/examples/addApiCollectionGenerate' Add a New Collection: $ref: '#/components/examples/addApiCollectionNew' commentCreate: required: true content: application/json: schema: $ref: '#/components/schemas/commentCreate' examples: Create Comment: $ref: '#/components/examples/commentCreate' Reply to Comment Thread: $ref: '#/components/examples/commentCreateReply' Tag User in Comment: $ref: '#/components/examples/commentTagUser' commentUpdate: required: true content: application/json: schema: $ref: '#/components/schemas/commentUpdate' examples: Update Comment: $ref: '#/components/examples/commentCreate' Tag User in Comment: $ref: '#/components/examples/commentTagUser' createApiSchema: description: The request body to create an API schema. content: application/json: schema: $ref: '#/components/schemas/createApiSchema' examples: Create JSON Schema: $ref: '#/components/examples/createJsonSchema' Create YAML Schema: $ref: '#/components/examples/createYamlSchema' Create GraphQL Schema: $ref: '#/components/examples/createGraphQlSchema' Create Schema with Proto: $ref: '#/components/examples/createProtoSchema' createUpdateApiSchemaFile: content: application/json: schema: $ref: '#/components/schemas/createUpdateApiSchemaFile' examples: JSON Schema: $ref: '#/components/examples/updateJsonSchema' YAML Schema: $ref: '#/components/examples/updateYamlSchema' GraphQL Schema: $ref: '#/components/examples/updateGraphQlSchema' Update root Tag: $ref: '#/components/examples/updateProtoSchema' migrateApiToSpecHub: content: application/json: schema: $ref: '#/components/schemas/migrateApiToSpecHub' examples: Migrate to Exisiting Workspace: $ref: '#/components/examples/migrateApiToSpecHubExistingWorkspace' Migrate to New Workspace: $ref: '#/components/examples/migrateApiToSpecHubNewWorkspace' Migrate Git-Connected Mono-Repo to New Workspace: $ref: '#/components/examples/migrateGitConnectedApiToSpecHub' tagUpdateTags: content: application/json: schema: $ref: '#/components/schemas/tagUpdateTags' examples: Update Tags: $ref: '#/components/examples/tagUpdateTags' createApiVersion: content: application/json: schema: anyOf: - $ref: '#/components/schemas/createGitUnlinkedVersionSchema' - $ref: '#/components/schemas/createGitLinkedVersion' - $ref: '#/components/schemas/createGitLinkedVersionRootFile' examples: Create Version: $ref: '#/components/examples/createGitUnlinkedVersionSchema' Git-Linked Version with Schema Directory Path: $ref: '#/components/examples/createGitLinkedVersion' Git-Linked Version with root File Integration: $ref: '#/components/examples/createGitLinkedVersionRootFile' updateApiVersion: content: application/json: schema: $ref: '#/components/schemas/updateApiVersion' examples: Update API Version: $ref: '#/components/examples/updateApiVersion' asyncCollectionForkMerge: content: application/json: schema: $ref: '#/components/schemas/asyncCollectionForkMerge' examples: Default: $ref: '#/components/examples/asyncCollectionForkMerge' Update Source with Destination: $ref: '#/components/examples/asyncCollectionForkMergeUpdateSource' Delete Source: $ref: '#/components/examples/asyncCollectionForkMergeDeleteSource' createCollection: content: application/json: schema: $ref: '#/components/schemas/createCollection' examples: Create Collection: $ref: '#/components/examples/createCollection' createCollectionFork: content: application/json: schema: $ref: '#/components/schemas/createCollectionFork' examples: Create Fork: $ref: '#/components/examples/createCollectionFork' mergeCollectionFork: content: application/json: schema: $ref: '#/components/schemas/mergeCollectionFork' examples: Merge Fork: $ref: '#/components/examples/mergeCollectionFork' putCollection: content: application/json: schema: $ref: '#/components/schemas/putCollection' examples: Replace a Basic Collection's Data: $ref: '#/components/examples/putCollection' patchCollection: content: application/json: schema: $ref: '#/components/schemas/patchCollection' examples: Update Auth: $ref: '#/components/examples/patchCollectionAuth' Update Events: $ref: '#/components/examples/patchCollectionEvents' Update Info: $ref: '#/components/examples/patchCollectionInfo' Update Variables: $ref: '#/components/examples/patchCollectionVariables' duplicateCollection: content: application/json: schema: $ref: '#/components/schemas/duplicateCollection' examples: Duplicate Collection: $ref: '#/components/examples/duplicateCollection' createCollectionFolder: content: application/json: schema: $ref: '#/components/schemas/createCollectionFolder' examples: Create Folder: $ref: '#/components/examples/createCollectionFolder' generateSpecFromCollection: content: application/json: schema: $ref: '#/components/schemas/generateSpecFromCollection' examples: Generate Spec from Collection: $ref: '#/components/examples/generateSpecFromCollection' publishDocumentation: content: application/json: schema: $ref: '#/components/schemas/publishDocumentation' examples: Publish Documentation: $ref: '#/components/examples/publishDocumentation' pullRequestCreate: content: application/json: schema: $ref: '#/components/schemas/pullRequestCreate' example: title: Test PR description: This is a test pull request. reviewers: - '87654321' - '56781234' destinationId: 12345678-ec548788-unftw-rgn8-83b8-0b59798648e4 createCollectionRequest: content: application/json: schema: $ref: '#/components/schemas/createCollectionRequest' examples: Create Request: $ref: '#/components/examples/createCollectionRequest' createCollectionResponse: content: application/json: schema: $ref: '#/components/schemas/createCollectionResponse' examples: Create Response: $ref: '#/components/examples/createCollectionResponse' updateCollectionRoles: content: application/json: schema: $ref: '#/components/schemas/updateCollectionRoles' examples: Update Collection Roles: $ref: '#/components/examples/updateCollectionRoles' updateCollectionFolder: content: application/json: schema: $ref: '#/components/schemas/updateCollectionFolder' examples: Update Folder: $ref: '#/components/examples/createCollectionFolder' updateCollectionRequest: content: application/json: schema: $ref: '#/components/schemas/updateCollectionRequest' examples: Update Request: $ref: '#/components/examples/updateCollectionRequest' updateCollectionResponse: content: application/json: schema: $ref: '#/components/schemas/updateCollectionResponse' examples: Update Response: $ref: '#/components/examples/updateCollectionResponse' transferCollectionItems: content: application/json: schema: $ref: '#/components/schemas/transferCollectionItems' examples: Transfer Collection Items: $ref: '#/components/examples/transferCollectionItems' createComponent: required: true content: application/json: schema: $ref: '#/components/schemas/createComponent' examples: Create Component: $ref: '#/components/examples/createComponent' updateComponent: content: application/json: schema: $ref: '#/components/schemas/updateComponent' examples: Rename Component: $ref: '#/components/examples/updateComponentName' Update Component Status: $ref: '#/components/examples/updateComponentStatus' updateComponentDraft: content: application/json: schema: $ref: '#/components/schemas/updateComponentDraft' examples: Update Component Draft: $ref: '#/components/examples/updateComponentDraft' createComponentVersion: required: true content: application/json: schema: $ref: '#/components/schemas/createComponentVersion' examples: Create Component Version from Draft: $ref: '#/components/examples/createComponentVersionDraftSource' submitContextGraphAsk: required: true content: application/json: schema: $ref: '#/components/schemas/submitContextGraphAsk' examples: Submit an Ask: $ref: '#/components/examples/submitContextGraphAsk' Structured Data Only: $ref: '#/components/examples/submitContextGraphAskStructuredOnly' createCustomFunction: required: true content: application/json: schema: $ref: '#/components/schemas/customFunctionCreate' examples: Create Custom Function: $ref: '#/components/examples/createCustomFunction' updateCustomFunction: required: true content: application/merge-patch+json: schema: $ref: '#/components/schemas/customFunctionUpdate' examples: Update Metadata: $ref: '#/components/examples/updateCustomFunctionMetadata' Replace Content: $ref: '#/components/examples/updateCustomFunctionContent' detectedSecretsQueries: content: application/json: schema: $ref: '#/components/schemas/detectedSecretsQueriesRequest' examples: Successful Response: $ref: '#/components/examples/detectedSecretsQueries' Filter by Resource Type: $ref: '#/components/examples/detectedSecretsQueryResource' updateSecretResolutions: content: application/json: schema: $ref: '#/components/schemas/updateSecretResolutionsRequest' examples: Update Secret Resolutions: $ref: '#/components/examples/updateSecretResolutions' createEnvironment: content: application/json: schema: $ref: '#/components/schemas/createEnvironment' examples: Create Environment: $ref: '#/components/examples/createEnvironment' putEnvironment: content: application/json: schema: $ref: '#/components/schemas/putEnvironment' examples: Replace Environment Data: $ref: '#/components/examples/putEnvironment' Remove Variables: $ref: '#/components/examples/putEnvironmentRemoveVariables' patchEnvironment: content: application/json: schema: anyOf: - $ref: '#/components/schemas/patchEnvironmentAdd' - $ref: '#/components/schemas/patchEnvironmentName' - $ref: '#/components/schemas/patchEnvironmentReplace' - $ref: '#/components/schemas/patchEnvironmentRemove' examples: Add Description to Existing Variable: $ref: '#/components/examples/patchEnvironmentAddDescriptionToExistingVariable' Add Variable: $ref: '#/components/examples/patchEnvironmentAddVariable' Add Secret Variable: $ref: '#/components/examples/patchEnvironmentAddSecretVariable' Enable Variable: $ref: '#/components/examples/patchEnvironmentEnableVariable' Remove Variable: $ref: '#/components/examples/patchEnvironmentRemove' Remove Multiple Variables: $ref: '#/components/examples/patchEnvironmentRemoveMultiple' Remove and Add Variable: $ref: '#/components/examples/patchEnvironmentRemoveAdd' Unshare Variable: $ref: '#/components/examples/patchEnvironmentUnshareVariable' Update Environment Name: $ref: '#/components/examples/patchEnvironmentName' Update Variable: $ref: '#/components/examples/patchEnvironmentUpdateVariable' forkEnvironment: content: application/json: schema: $ref: '#/components/schemas/forkEnvironment' examples: Fork Environment: $ref: '#/components/examples/forkEnvironment' mergeEnvironmentFork: content: application/json: schema: $ref: '#/components/schemas/mergeEnvironmentFork' examples: Merge Environment Fork: $ref: '#/components/examples/mergeEnvironmentFork' pullEnvironment: content: application/json: schema: $ref: '#/components/schemas/pullEnvironment' examples: Pull Source Change: $ref: '#/components/examples/pullEnvironment' createGovernanceGroup: required: true content: application/json: schema: $ref: '#/components/schemas/governanceGroupCreate' examples: Create Governance Group: $ref: '#/components/examples/createGovernanceGroup' updateGovernanceGroup: required: true content: application/merge-patch+json: schema: $ref: '#/components/schemas/governanceGroupUpdate' examples: Update Governance Group: $ref: '#/components/examples/updateGovernanceGroup' updateGovernanceGroupWorkspaces: required: true content: application/json: schema: $ref: '#/components/schemas/bulkWorkspacesRequest' examples: Assign and Unassign Workspaces: $ref: '#/components/examples/updateGovernanceGroupWorkspaces' importOpenApiDefinition: content: application/json: schema: anyOf: - $ref: '#/components/schemas/jsonSchema' - $ref: '#/components/schemas/jsonStringified' examples: Import an OpenAPI: $ref: '#/components/examples/importOpenApiStringDefinition' Import an OpenAPI Definition with Options: $ref: '#/components/examples/importOpenApiStringDefinitionOptions' multipart/form-data: schema: $ref: '#/components/schemas/importExportFile' example: type: file input: openapi-spec.zip managePartnerWorkspaceInvites: content: application/json: schema: oneOf: - $ref: '#/components/schemas/managePartnerWorkspaceInvitesInvitePartner' - $ref: '#/components/schemas/managePartnerWorkspaceInvitesRemovePartner' - $ref: '#/components/schemas/managePartnerWorkspaceInvitesRemovePartnerTeam' examples: Invite Partners to Partner Workspace: $ref: '#/components/examples/managePartnerWorkspaceInvitesInvitePartners' Remove Partner from Workspace: $ref: '#/components/examples/managePartnerWorkspaceInvitesRemovePartnerFromWorkspace' Remove Partner From Partnership: $ref: '#/components/examples/managePartnerWorkspaceInvitesRemovePartnerFromTeam' createMock: required: true content: application/json: schema: $ref: '#/components/schemas/createMock' examples: Create Mock: $ref: '#/components/examples/createMock' updateMock: content: application/json: schema: $ref: '#/components/schemas/updateMock' examples: Update Mock Properties: $ref: '#/components/examples/updateMock' Update Collection and Environment: $ref: '#/components/examples/updateMockCollectionEnvironment' createMockServerResponse: required: true content: application/json: schema: $ref: '#/components/schemas/createMockServerResponse' examples: Create Server Response: $ref: '#/components/examples/createMockServerResponse' updateMockServerResponse: required: true content: application/json: schema: $ref: '#/components/schemas/updateMockServerResponse' examples: Update Server Response: $ref: '#/components/examples/updateMockServerResponse' createMonitor: content: application/json: schema: $ref: '#/components/schemas/createMonitor' examples: Create Monitor: $ref: '#/components/examples/monitorCreate' updateMonitor: content: application/json: schema: $ref: '#/components/schemas/updateMonitor' examples: Update Monitor: $ref: '#/components/examples/monitorUpdate' Pause Monitor: $ref: '#/components/examples/monitorPause' Resume Monitor: $ref: '#/components/examples/monitorResume' postPanElement: required: true content: application/json: schema: $ref: '#/components/schemas/panCreateWorkspace' examples: Add a Workspace: $ref: '#/components/examples/postPanWorkspace' updatePanElement: required: true content: application/json: schema: $ref: '#/components/schemas/updatePanWorkspace' examples: Update a Workspace: $ref: '#/components/examples/updatePanWorkspace' respondPanElementAddRequest: content: application/json: schema: $ref: '#/components/schemas/respondPanElementAddRequestBody' examples: Request Approved: $ref: '#/components/examples/respondPanElementAddRequestApprove' Request Denied: $ref: '#/components/examples/respondPanElementAddRequestDeny' generateOauthToken: content: application/json: schema: $ref: '#/components/schemas/generateOauthToken' examples: Generate an OAuth Token: $ref: '#/components/examples/generateOauthToken' revokeOauthToken: content: application/json: schema: $ref: '#/components/schemas/revokeOauthToken' examples: Revoke an OAuth Token: $ref: '#/components/examples/revokeOauthToken' createPackage: required: true content: application/json: schema: $ref: '#/components/schemas/createPackage' examples: Create Package: $ref: '#/components/examples/createPackage' updatePackage: required: true content: application/merge-patch+json: schema: $ref: '#/components/schemas/updatePackage' examples: Update Package: $ref: '#/components/examples/updatePackage' generateTool: content: application/json: schema: $ref: '#/components/schemas/generateTool' examples: Generate Tool: $ref: '#/components/examples/generateTool' pullRequestUpdate: content: application/json: schema: $ref: '#/components/schemas/pullRequestUpdate' example: description: Updated description of the pull request. reviewers: - '12345678' - '87654321' title: Updated PR title pullRequestReview: content: application/json: schema: $ref: '#/components/schemas/pullRequestReview' examples: Approve: value: action: approve Merge: value: action: merge Decline: value: action: decline comment: Missing descriptions in requests Unapprove: value: action: unapprove createRuleset: required: true content: application/json: schema: $ref: '#/components/schemas/rulesetCreate' examples: Create Ruleset: $ref: '#/components/examples/createRuleset' updateRuleset: required: true content: application/merge-patch+json: schema: $ref: '#/components/schemas/rulesetUpdate' examples: Update Metadata: $ref: '#/components/examples/updateRulesetMetadata' Replace Content: $ref: '#/components/examples/updateRulesetContent' createRulesetAssignment: required: true content: application/json: schema: $ref: '#/components/schemas/rulesetAssignmentCreate' examples: Assign Ruleset: $ref: '#/components/examples/createRulesetAssignment' schemaSecurityValidation: content: application/json: schema: $ref: '#/components/schemas/schemaSecurityValidationRequest' examples: Request Body: $ref: '#/components/examples/schemaSecurityValidationRequest' createScimGroup: content: application/json: schema: $ref: '#/components/schemas/createScimGroup' examples: Create SCIM Group: $ref: '#/components/examples/createScimGroup' scimUpdateGroup: content: application/json: schema: $ref: '#/components/schemas/scimUpdateGroup' examples: Update SCIM Group: $ref: '#/components/examples/scimUpdateGroup' createScimUser: content: application/json: schema: $ref: '#/components/schemas/createScimUser' examples: Create SCIM User: $ref: '#/components/examples/createScimUser' updateScimUser: content: application/json: schema: $ref: '#/components/schemas/updateScimUser' examples: Update SCIM User: $ref: '#/components/examples/updateScimUser' Update User Email: $ref: '#/components/examples/updateScimUserEmail' updateScimUserPatch: content: application/json: schema: $ref: '#/components/schemas/updateScimUserPatch' examples: Update SCIM User State: $ref: '#/components/examples/updateScimUserPatch' Update SCIM User Username: $ref: '#/components/examples/updateScimUserPatchEmail' createSdk: required: true content: application/json: schema: $ref: '#/components/schemas/createSdk' examples: Create a TypeScript SDK: $ref: '#/components/examples/createSdkTypescript' Generate a Python SDK: $ref: '#/components/examples/createSdkPython' Generate a Go SDK: $ref: '#/components/examples/createSdkGo' Generate a Java SDK: $ref: '#/components/examples/createSdkJava' Generate a C# SDK: $ref: '#/components/examples/createSdkCsharp' Generate a Ruby SDK: $ref: '#/components/examples/createSdkRuby' Generate a PHP SDK: $ref: '#/components/examples/createSdkPhp' Generate a Kotlin SDK: $ref: '#/components/examples/createSdkKotlin' Generate a Rust SDK: $ref: '#/components/examples/createSdkRust' Generate a CLI SDK: $ref: '#/components/examples/createSdkCli' createSdkGitConnection: required: true content: application/json: schema: $ref: '#/components/schemas/createSdkGitConnection' examples: Connect a Repository: $ref: '#/components/examples/createSdkGitConnection' Connect Without Automatic Pull Requests: $ref: '#/components/examples/createSdkGitConnectionManual' updateSdkGitConnection: required: true content: application/json: schema: $ref: '#/components/schemas/updateSdkGitConnection' examples: Disconnect an SDK Git Connection: $ref: '#/components/examples/updateSdkGitConnection' Enable Automatic Pull Requests: $ref: '#/components/examples/updateSdkGitConnectionAutoUpdate' searchPostmanResources: content: application/json: schema: $ref: '#/components/schemas/searchPostmanResources' examples: Search Workspaces: $ref: '#/components/examples/searchPostmanResourcesWorkspaces' Search Team's Public Workspaces: $ref: '#/components/examples/searchPostmanResourcesPublicWorkspaces' Search Public Workspaces with Verified Publishers: $ref: '#/components/examples/searchPostmanResourcesPublicWorkspacesVerifiedPublishers' Search Partner Workspaces: $ref: '#/components/examples/searchPostmanResourcesPartnerWorkspaces' Search Private API Network: $ref: '#/components/examples/searchPostmanResourcesPrivateApiNetwork' Search External Public APIs: $ref: '#/components/examples/searchPostmanResourcesExternalPublicApis' Search Flows: $ref: '#/components/examples/searchPostmanResourcesFlows' Search Internal APIs in Organization: $ref: '#/components/examples/searchPostmanResourcesInternalApisOrg' Search Requests with $ne Filter: $ref: '#/components/examples/searchPostmanResourcesRequestsNeFilter' createSpec: content: application/json: schema: $ref: '#/components/schemas/createSpec' examples: Create OpenAPI JSON Spec: $ref: '#/components/examples/createSpecJson' Create OpenAPI YAML Spec: $ref: '#/components/examples/createSpecYaml' Create AsyncAPI 2.0 JSON Spec: $ref: '#/components/examples/createSpecAsync2Json' Create AsyncAPI 2.0 YAML Spec: $ref: '#/components/examples/createSpecAsync2Yaml' Create AsyncAPI 3.0 JSON Spec: $ref: '#/components/examples/createSpecAsync3Json' Create AsyncAPI 3.0 YAML Spec: $ref: '#/components/examples/createSpecAsync3Yaml' Create a GraphQL Spec: $ref: '#/components/examples/createSpecGraphQL' Create a Protobuf 2 Spec: $ref: '#/components/examples/createSpecProtobuf2' Create a Protobuf 3 Spec: $ref: '#/components/examples/createSpecProtobuf3' Create a Smithy Spec: $ref: '#/components/examples/createSpecSmithy' Create Multi-File Spec: $ref: '#/components/examples/createMultiFileSpec' updateSpecProperties: content: application/json: schema: $ref: '#/components/schemas/updateSpecProperties' examples: Rename Spec: $ref: '#/components/examples/updateSpecPropertiesRename' updateSpecSyncOptions: content: application/json: schema: $ref: '#/components/schemas/apiSpecSyncOptions' examples: Update Sync Options: $ref: '#/components/examples/updateSpecSyncOptions' createSpecFile: description: Create Spec File content: application/json: schema: $ref: '#/components/schemas/createSpecFile' examples: Create JSON Spec File: $ref: '#/components/examples/createJsonSpecFile' Create YAML Spec File: $ref: '#/components/examples/createYamlSpecFile' Create Protobuf Spec File: $ref: '#/components/examples/createProtobufSpecFile' Create a Nested Spec File: $ref: '#/components/examples/createNestedSpecFile' updateSpecFile: description: Update Spec File content: application/json: schema: $ref: '#/components/schemas/updateSpecFile' examples: Update JSON Spec File: $ref: '#/components/examples/updateJsonSpecFile' Update YAML Spec File: $ref: '#/components/examples/updateYamlSpecFile' Update Protobuf Spec File: $ref: '#/components/examples/updateProtobufSpecFile' Update File Type: $ref: '#/components/examples/updateJsonSpecFileType' Update File Name: $ref: '#/components/examples/updateJsonSpecFileName' Invalid Request Body: $ref: '#/components/examples/updateJsonSpecFileInvalidBody' generateCollection: content: application/json: schema: $ref: '#/components/schemas/generateCollection' examples: Generate a Collection: $ref: '#/components/examples/generateCollection' createSpecVersionTag: content: application/json: schema: $ref: '#/components/schemas/createSpecVersionTag' examples: Create a Version Tag: $ref: '#/components/examples/createSpecVersionTag' createTeam: content: application/json: schema: $ref: '#/components/schemas/createTeam' examples: Create a Team: $ref: '#/components/examples/createTeam' createAccessRequest: content: application/json: schema: $ref: '#/components/schemas/createAccessRequest' examples: Request a Role for User: $ref: '#/components/examples/createAccessRequestUserRole' Request User as Guest Viewer: $ref: '#/components/examples/createAccessRequestGuestRole' Request to Add Users as Guest Developers: $ref: '#/components/examples/createAccessRequestGuestDevelopers' Request a Role Upgrade: $ref: '#/components/examples/createAccessRequestRoleUpgrade' Request Team as Guest Viewer to a Team: $ref: '#/components/examples/createAccessRequestGuestTeamViewer' Request to Add Organization: $ref: '#/components/examples/createAccessRequestOrganization' Request Organization Role Upgrade: $ref: '#/components/examples/createAccessRequestOrganizationRoleUpgrade' approveDenyAccessRequest: content: application/json: schema: $ref: '#/components/schemas/approveDenyAccessRequest' examples: Approve an Access Request: $ref: '#/components/examples/approveDenyAccessRequest' Deny an Access Request: $ref: '#/components/examples/approveDenyAccessRequestDeny' manageTeamMemberRoles: content: application/json: schema: $ref: '#/components/schemas/manageTeamMemberRoles' examples: Assign Team Member's Role: $ref: '#/components/examples/manageTeamMemberRolesAssignTeamMemberRole' Update Team Member's Role: $ref: '#/components/examples/manageTeamMemberRolesUpdateTeamMemberRole' Update Team Organization's Role: $ref: '#/components/examples/manageTeamMemberRolesUpdateTeamOrgRole' Update Team Role: $ref: '#/components/examples/manageTeamMemberRolesUpdateTeamRole' Update Team Member's Role with SCIM ID: $ref: '#/components/examples/manageTeamMemberRolesUpdateTeamRoleScimId' Remove Team Member's Role: $ref: '#/components/examples/manageTeamMemberRolesRemoveTeamRole' Add and Remove Roles: $ref: '#/components/examples/manageTeamMemberRolesAddRemoveRoles' Add and Remove Roles with SCIM IDs: $ref: '#/components/examples/manageTeamMemberRolesAddRemoveRolesScimId' removeTeamMembers: content: application/json: schema: $ref: '#/components/schemas/removeTeamMembers' examples: Remove Team Members: $ref: '#/components/examples/removeTeamMembersRemoveMembers' Remove Organization: $ref: '#/components/examples/removeTeamMembersRemoveOrganization' Remove Team: $ref: '#/components/examples/removeTeamMembersRemoveTeam' Remove Team Member with SCIM IDs: $ref: '#/components/examples/removeTeamMembersRemoveMembersScimId' Remove User and Group Team Members: $ref: '#/components/examples/removeTeamMembersRemoveUserAndGroupTeamMembers' updateTeamSettings: content: application/json: schema: $ref: '#/components/schemas/updateTeamSettings' examples: Update Team Settings: $ref: '#/components/examples/updateTeamSettings' createWebhook: content: application/json: schema: $ref: '#/components/schemas/createWebhook' examples: Create Webhook: $ref: '#/components/examples/createWebhook' createWorkspace: content: application/json: schema: $ref: '#/components/schemas/createWorkspace' examples: Create Workspace: $ref: '#/components/examples/createWorkspace' Create Workspace in a Team: $ref: '#/components/examples/createWorkspaceInTeam' updateWorkspace: content: application/json: schema: $ref: '#/components/schemas/updateWorkspace' examples: Update Workspace Properties: $ref: '#/components/examples/updateWorkspace' Update Workspace Name and Description: $ref: '#/components/examples/updateWorkspaceNameDescription' Update Workspace Type: $ref: '#/components/examples/updateWorkspaceType' transferWorkspaceElement: content: application/json: schema: $ref: '#/components/schemas/transferWorkspaceElement' examples: Transfer Collection: $ref: '#/components/examples/transferWorkspaceElementCollection' Transfer Environment: $ref: '#/components/examples/transferWorkspaceElementEnvironment' Transfer Flow: $ref: '#/components/examples/transferWorkspaceElementFlow' Transfer Mock: $ref: '#/components/examples/transferWorkspaceElementMock' Transfer Monitor: $ref: '#/components/examples/transferWorkspaceElementMonitor' updateWorkspaceGlobalVariables: content: application/json: schema: $ref: '#/components/schemas/updateWorkspaceGlobalVariables' examples: Update Global Variables: $ref: '#/components/examples/updateWorkspaceGlobalVariables' updateWorkspaceRoles: content: application/json-patch+json: schema: $ref: '#/components/schemas/updateWorkspaceRoles' examples: Update User Role: $ref: '#/components/examples/updateUserRole' Update Role with SCIM ID: $ref: '#/components/examples/updateRoleSCIMId' Update Role and Group with SCIM IDs: $ref: '#/components/examples/updateRoleGroupSCIMId' Add Workspace Group Role: $ref: '#/components/examples/addWorkspaceGroupRole' Remove Workspace Group Role: $ref: '#/components/examples/removeWorkspaceGroupRole' Add and Remove Partner Roles: $ref: '#/components/examples/addRemovePartnerRoles' transferWorkspaceToTeam: content: application/json: schema: $ref: '#/components/schemas/transferWorkspaceToTeam' examples: Transfer Workspace to Team: $ref: '#/components/examples/transferWorkspaceToTeam' createWorkspaceUpdate: content: application/json: schema: $ref: '#/components/schemas/createWorkspaceUpdate' examples: Create Workspace Update: $ref: '#/components/examples/createWorkspaceUpdate' updateWorkspaceUpdate: content: application/json: schema: $ref: '#/components/schemas/updateWorkspaceUpdate' examples: Update a Workspace Update: $ref: '#/components/examples/updateWorkspaceUpdate' headers: Location: description: The URL to get or poll the status of an API version task created. schema: type: string example: /apis/6138195-0262634b-cdcb-4a03-a4b9-2b221eccfbaa/tasks/66ae9950-0869-4e65-96b0-1e0e47e771af