{ "opencollection": "1.0.0", "info": { "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Private API Network API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Private API Network", "type": "folder" }, "items": [ { "info": { "name": "APIs.io Engineering Platform Get all elements and folders", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/network/private", "params": [ { "name": "since", "value": "", "type": "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." }, { "name": "until", "value": "", "type": "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." }, { "name": "addedBy", "value": "", "type": "query", "description": "Return only elements published by the given user ID." }, { "name": "name", "value": "", "type": "query", "description": "Return only elements whose name includes the given value. Matching is not case-sensitive." }, { "name": "summary", "value": "", "type": "query", "description": "Return only elements whose summary includes the given value. Matching is not case-sensitive." }, { "name": "description", "value": "", "type": "query", "description": "Return only elements whose description includes the given value. Matching is not case-sensitive." }, { "name": "sort", "value": "", "type": "query", "description": "Sort the results by the given value. If you use this query parameter, you must also use the `direction` parameter." }, { "name": "direction", "value": "", "type": "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." }, { "name": "createdBy", "value": "", "type": "query", "description": "Return only results created by the given user ID." }, { "name": "offset", "value": "", "type": "query", "description": "The zero-based offset of the first item to return." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of elements to return. If the value exceeds the maximum value of `1000`, then the system uses the `1000` value." }, { "name": "parentFolderId", "value": "", "type": "query", "description": "Return the folders and elements in a specific folder. If this value is `0`, then the endpoint only returns the root folder's elements." }, { "name": "type", "value": "", "type": "query", "description": "Filter by the element type." } ] }, "docs": "Gets information about the folders and their elements added to your [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).\n\n**Note:**\n\nThe `limit` and `offset` parameters are separately applied to elements and folders. For example, if you query a `limit` value of `10` and an `offset` value `0`, the endpoint returns 10 elements and 10 folders for a total of 20 items. The `totalCount` property in the `meta` response is the total count of both ele" }, { "info": { "name": "APIs.io Engineering Platform Add an element or folder", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/network/private", "body": { "type": "json", "data": "{}" } }, "docs": "Publishes a element or creates a folder in your [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). An element is a Postman API, collection, or workspace.\n\n**Note:**\n\nYou can only pass one element object type per call. For example, you cannot pass both `api` and `collection` in a single request.\n" }, { "info": { "name": "APIs.io Engineering Platform Update an element or folder", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/network/private/:elementType/:elementId", "params": [ { "name": "elementId", "value": "", "type": "path", "description": "The element's ID or UUID. For Postman Collections you must pass the collection's UID (`userId`-`collectionId`) value." }, { "name": "elementType", "value": "", "type": "path", "description": "The element type." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an element or folder in your [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).\n\n**Note:**\n\nYou can only pass one element object type per call. For example, you cannot pass both `api` and `collection` in a single request.\n" }, { "info": { "name": "APIs.io Engineering Platform Remove an element or folder", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/network/private/:elementType/:elementId", "params": [ { "name": "elementId", "value": "", "type": "path", "description": "The element's ID or UUID. For Postman Collections you must pass the collection's UID (`userId`-`collectionId`) value." }, { "name": "elementType", "value": "", "type": "path", "description": "The element type." } ] }, "docs": "Removes an element or delete a folder from your [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).\n\n**Note:**\n\nRemoving an API, collection, or workspace element does not delete it. It only removes it from the Private API Network folder.\n" }, { "info": { "name": "APIs.io Engineering Platform Get all element add requests", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/network/private/network-entity/request/all", "params": [ { "name": "since", "value": "", "type": "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." }, { "name": "until", "value": "", "type": "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." }, { "name": "requestedBy", "value": "", "type": "query", "description": "Return a user's element requests by their user ID." }, { "name": "type", "value": "", "type": "query", "description": "Filter by the element type." }, { "name": "status", "value": "", "type": "query", "description": "Filter by the request status." }, { "name": "name", "value": "", "type": "query", "description": "Return only elements whose name includes the given value. Matching is not case-sensitive." }, { "name": "sort", "value": "", "type": "query", "description": "Sort the results by the given value. If you use this query parameter, you must also use the `direction` parameter." }, { "name": "direction", "value": "", "type": "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." }, { "name": "offset", "value": "", "type": "query", "description": "The zero-based offset of the first item to return." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of elements to return. If the value exceeds the maximum value of `1000`, then the system uses the `1000` value." } ] }, "docs": "Gets a list requests to add elements to the [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/)." }, { "info": { "name": "APIs.io Engineering Platform Respond to an element add request", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/network/private/network-entity/request/:requestId", "params": [ { "name": "requestId", "value": "", "type": "path", "description": "The element request's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Responds to a request to add an element to the [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 element will appear in the team's Private API Network." } ] } ], "bundled": true }