{ "opencollection": "1.0.0", "info": { "name": ".io Engineering Platform Amazon API Gateway 2014 11 13 Apis API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Apis", "type": "folder" }, "items": [ { "info": { "name": "APIs.io Engineering Platform Get all APIs", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/apis", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "workspaceId", "value": "", "type": "query", "description": "The workspace's ID." }, { "name": "createdBy", "value": "", "type": "query", "description": "Return only results created by the given user ID." }, { "name": "cursor", "value": "", "type": "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." }, { "name": "description", "value": "", "type": "query", "description": "Return only APIs whose description includes the given value. Matching is not case-sensitive." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of rows to return in the response." } ] }, "docs": "Gets information about all APIs in a workspace." }, { "info": { "name": "APIs.io Engineering Platform Create an API", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/apis", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "workspaceId", "value": "", "type": "query", "description": "The workspace's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an API." }, { "info": { "name": "APIs.io Engineering Platform Get an API", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/apis/:apiId", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The API's ID." }, { "name": "include", "value": "", "type": "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:\n- `collections` — Query for linked Postman collections.\n- `versions` — Query for linked versions.\n- `schemas` — Query for linked schemas.\n- `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.\n\n**Note:**\n\nAPI viewers can only use the `versions` option.\n" } ] }, "docs": "Gets information about an API.\n\n**Note:**\n\n- 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.\n- API viewers can only use the `versions` option in the `include` query parameter.\n" }, { "info": { "name": "APIs.io Engineering Platform Update an API", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/apis/:apiId", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The API's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an API." }, { "info": { "name": "APIs.io Engineering Platform Delete an API", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/apis/:apiId", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The API's ID." } ] }, "docs": "Deletes an API. On success, this returns an HTTP `204 No Content` response." }, { "info": { "name": "APIs.io Engineering Platform Get status of an asynchronous task", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/apis/:apiId/tasks/:taskId", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The API's ID." }, { "name": "taskId", "value": "", "type": "path", "description": "The task's ID." } ] }, "docs": "Gets the status of an asynchronous task." }, { "info": { "name": "APIs.io Engineering Platform Get a version", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/apis/:apiId/versions/:versionId", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The API's ID." }, { "name": "versionId", "value": "", "type": "path", "description": "The API's version ID." } ] }, "docs": "Gets information about an API version.\n\n**Note:**\n\n- 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.\n- For API viewers, this endpoint returns an HTTP `404 Not Found` when the version status is pending.\n" } ] } ], "bundled": true }