The `/collections` endpoint returns a list of all [collections](https://www.getpostman.com/docs/collections) that are accessible by you. The list includes your own collections and the collections that you have subscribed to. The response contains an array of collection information containing the `name`, `id`, `owner` and `uid` of each collection. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
The `/environments` endpoint returns a list of all [environments](https://www.getpostman.com/docs/environments) that belong to you.. The response contains an array of environments' information containing the `name`, `id`, `owner` and `uid` of each environment. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint fetches all the mocks that you have created. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
The `/monitors` endpoint returns a list of all [monitors](https://monitor.getpostman.com/) that are accessible by you. The response contains an array of monitors information containing the `name`, `id`, `owner` and `uid` of each monitor. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
The `/workspaces` endpoint returns a list of all [workspaces](https://www.getpostman.com/docs/v6/postman/workspaces/intro_to_workspaces) that is accessible by you. The list includes your own workspaces and the workspaces that you have access to. The response contains an array of collection information containing the `name`, `id`, and `type` of each workspace. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
the `/me` Postman API endpoint lets you access information about the authenticated user. You can retrieve the authenticated user's username, full name, e-mail address, and any other available information. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint allows you to create a fork from an existing collection. On successful creation of the collection, the response returns the collection `name`, `id`, `uid` along with `fork` information. You can also specify the context of a workspace to fork a collection in by passing the `workspace` as a query param. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This call creates a new API with a default API Version. Request body should contain an `api` object which should atleast have a property `name`. Response contains an `api` object with all the details related to the created API, namely, `id`, `name`, `summary`, `description`, etc. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint allows you to create collections using the Postman Collection v2 format. For more information about the v2 schema, check the format [here](https://schema.getpostman.com/json/collection/v2.0.0/docs/index.html). On successful creation of the collection, the response returns the collection `name`, `id` and the `uid`. You can also specify the context of a workspace to create a collection in directly by passing the `workspace` as a query param. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
A sample body is added to the request that conforms to the following JSON schema: ```json { "type": "object", "properties": { "environment": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 254, "minLength": 1 }, "values": { "type": "array", "maxItems": 100, "additionalItems": false, "items": { "type": "object", "properties": { "key": { "type": "string", "maxLength": 254 "minLength": 1 }, "value": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": ["key", "value"] } } }, "required": ["name"] } }, "required": ["environment"] } ``` On successful creation of the environment, the API returns the environment name and `id`. You can also specify the context of a workspace to create an environment in directly by passing the `workspace` as a query param. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint allows you to create a mock on a collection. You can also provide an environment UID to resolve any environment variables in the collection. You can also specify the context of a workspace to create a mock in directly by passing the `workspace` as a query param. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint allows you to create a monitor. Some sample `cron` values are: | Frequency | Cron Pattern | |-----------------------|----------------| | Every 5 minutes | `*/5 * * * *` | | Every 30 minutes | `*/30 * * * *` | | Every Hour | `0 */1 * * *` | | Every 6 Hours | `0 */6 * * *` | | Every day at 5pm | `0 17 * * *` | | Every Monday at 12pm | `0 12 * * MON` | | Every weekday (Monday - Friday) at 6am | `0 6 * * MON-FRI` | Note: Currently, you can only create monitors at some limited schedules. You can head to [Postman Monitors](https://monitor.getpostman.com) to see the allowed schedules. For more information about the format of the `timezone` value, check this [list of time zones.](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) You can also specify the context of a workspace to create a monitor in directly by passing the `workspace` as a query param. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This call allows you to add existing Postman entities as new relations to an API. The request body should contain the relations to be created along with an array of entity IDs. <table> <tr> <th>Relation</th> <th>Entity ID type</th> <tr> <tr> <td>contracttest</td> <td>Collection UIDs</td> </tr> <tr> <td>integrationtest</td> <td>Collection UIDs</td> </tr> <tr> <td>documentation</td> <td>Collection UIDs</td> </tr> <tr> <td>testsuite</td> <td>Collection UIDs</td> </tr> <tr> <td>environment</td> <td>Environment UIDs</td> </tr> <tr> <td>mock</td> <td>Mock IDs</td> </tr> <tr> <td>monitor</td> <td>Monitor IDs</td> </tr> </table> > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint allows you to create a workspace and populate it with entities like `collections`, `environments`, `mocks` and `monitors` using their `uid`. On successful creation of the workspace, the response returns the workspcae `name` and `id`. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This call deletes an existing API having the specified id. Response contains an `api` object with `id` of the API which was deleted. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint allows you to delete an existing collection. On successful deletion of the collection, the response returns the `id` and `uid`. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint allows you to delete a single environment based on an environment's unique `uid`. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint allows you to delete an existing mock using its `uid`. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint can be used to delete an existing monitor using its `uid`. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint allows you to delete an existing workspace. On successful deletion of the workspace, the response returns the `id`. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This call fetches all the relations by type which are linked to the specified API version along with their details. The response will contain an array with key `{{relationType}}`. Each of the item will consist of all the details related each of the relation. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This call fetches all the APIs present in the specified workspace Response contains an array named `apis` which would contain all the details of APIs present in the workspace. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This call fetches all the relations by type which are linked to the specified API version along with their details. The response will contain an array with key `{{relationType}}`. Each of the item will consist of all the details related each of the relation. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This call fetches all the relations by type which are linked to the specified API version along with their details. The response will contain an array with key `{{relationType}}`. Each of the item will consist of all the details related each of the relation. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This call fetches all the relations by type which are linked to the specified API version along with their details. The response will contain an array with key `{{relationType}}`. Each of the item will consist of all the details related each of the relation. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This call fetches all the relations which are linked to the specified API version along with their details. The response will contain a `relations` object which lists all the relation types which are linked to the API version. Each of the relation type will be an object which details the relations of this type. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This call fetches all the relations by type which are linked to the specified API version along with their details. The response will contain an array with key `{{relationType}}`. Each of the item will consist of all the details related each of the relation. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This call fetches all the relations by type which are linked to the specified API version along with their details. The response will contain an array with key `{{relationType}}`. Each of the item will consist of all the details related each of the relation. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint allows you to merge a forked collection back to its destination collection. On successful creation of the collection, the response returns the collection `name`, `id` and `uid`. You need to specify the fork UID (as `source`) and destination collection UID (as `destination`) in the request body. Optionally, you can also specify the merge strategy as either `deleteSource` or `updateSourceWithDestination`. Following is an explanation of the merge strategies | Merge Strategy | Behaviour | | --- | --- | | deleteSource | Forked collection is deleted after merging | | updateSourceWithDestination | Forked collection is up to date with changes in destination collection | If the collections cannot be merged (due to conflicts), appropriate error messages will be returned. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint publishes the mock you have created using its `uid` > Requires <a href="#authentication">API Key</a> as `X-Api-Key ` request header or `apikey` URL query parameter.
This endpoint will run the monitor instantly and wait for the monitor to run completely. It responds with the run results. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This call fetches a single API having the specified id. Response contains an `api` object with all the details related to the queried API, namely, `id`, `name`, `summary`, `description` etc. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
Access the contents of a collection that is accessible to you using its unique id (`uid`). > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
Access the contents of an environment that is accessible to you using its unique id (`uid`). > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint fetches you the basic information about a single mock using its `uid`. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint fetches you basic information about the monitor using its `uid`. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
Access the contents of a workspace that is accessible to you using its id (`id`). Includes the collections, environments, mocks and monitors of that workspace. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint unpublishes the mock you have created using its `uid` > Requires <a href="#authentication">API Key</a> as `X-Api-Key ` request header or `apikey` URL query parameter.
This call updates an existing API . Request body should contain an `api` object which should have the fields to be updated. Only `name`, `summary` and `description` fields can be edited for an API. Response contains an `api` object with all the details related to the created API, namely, `id`, `name`, `summary`, `description` etc. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint allows you to update an existing collection using the Postman Collection v2 format. For more information about the v2 schema, check the format [here](https://schema.getpostman.com/json/collection/v2.0.0/docs/index.html). On successful updation of the collection, the response returns the collection `name`, `id` and `uid`. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter. Note: Please be careful when trying to update the collection, as the existing collection will be replaced by the request body.
This endpoint replaces an existing environment. A sample body is added to the request that conforms to the following JSON schema: ```json { "type": "object", "properties": { "environment": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 254, "minLength": 1 }, "values": { "type": "array", "maxItems": 100, "additionalItems": false, "items": { "type": "object", "properties": { "key": { "type": "string", "maxLength": 254, "minLength": 1 }, "value": { "type": "string", "maxLength": 254, "minLength": 1 }, "type": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "key", "value" ] } } } } }, "required": [ "environment" ] } ``` On successful updation of the environment, the API returns the environment name and `id`. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint allows you to update a mock you have created using its `uid`. The endpoint allows you to edit fields, * name * environment * description * private * versionTag > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint allows you to update a monitor using its `uid`. Only the monitor name and its schedule can be updated. Some example `cron` values are: | Frequency | Cron Pattern | |-----------------------|----------------| | Every 5 minutes | `*/5 * * * *` | | Every 30 minutes | `*/30 * * * *` | | Every Hour | `0 */1 * * *` | | Every 6 Hours | `0 */6 * * *` | | Every day at 5pm | `0 17 * * *` | | Every Monday at 12pm | `0 12 * * MON` | | Every weekday (Monday - Friday) at 6am | `0 6 * * MON-FRI` | Note: Currently, you can only create monitors at some limited schedules. You can head to [Postman Monitors](https://monitor.getpostman.com) to see the allowed schedules. For more information about the format of the `timezone` value, check this [list of time zones.](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.
This endpoint allows you to update a workspace and update it's association to entities like `collections`, `environments`, `mocks` and `monitors` using their `uid`. On successful updation of the workspace, the response returns the workspcae `name` and `id`. > Requires <a href="#authentication">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter. **Note** : The endpoint expects you to send the desired state of the workspace in terms of the associated entities so be careful when trying to update these entities. For eg. if your workspace has collections A and B, and in the update call, you send C's uid in the collections array, then A and B would be removed from the workspace and C would be added.
Tell us which provider you need, and we will ship it in the registry.
Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.