{ "opencollection": "1.0.0", "info": { "name": "Tyk Dashboard Admin Additional Permissions APIs API", "version": "5.3.0" }, "request": { "auth": { "type": "apikey", "key": "Admin-Auth", "value": "{{Admin-Auth}}", "placement": "header" } }, "items": [ { "info": { "name": "APIs", "type": "folder" }, "items": [ { "info": { "name": "Get List of APIs", "type": "http" }, "http": { "method": "GET", "url": "http://localhost/api/apis", "params": [ { "name": "compressed", "value": "1", "type": "query", "description": "Return smaller API list payload." }, { "name": "api_type", "value": "rest", "type": "query", "description": "API Type, internal or external." }, { "name": "category", "value": "", "type": "query", "description": "Comma separated list of categories you want to filter Apis by." }, { "name": "auth_type", "value": "keyless,authToken", "type": "query", "description": "Comma separated list of authentication type you want to filter apis by." }, { "name": "base_apis", "value": "1", "type": "query", "description": "For versioned APIs, return only the base versions.If any value is sent in this query parameter only the base version will be returned" }, { "name": "q", "value": "Rate Limit Path API 1", "type": "query", "description": "Query string for search/filtering.This will return all apis whose names matches the given pattern" }, { "name": "p", "value": "1", "type": "query", "description": "Use p query parameter to say which page you want returned. Send number less than 0 to return all items." }, { "name": "sort", "value": "name", "type": "query", "description": "* 'name' - Sort by name in ascending order.\n* '-name' - Sort by name in descending order.\n* 'updated_at' - Sort by updated_at in ascending order.\n* '-updated_at' - Sort by updated_at in descending order.\n* 'created_at' - Sort by created_at in ascending order.\n* '-created_at' - Sort by created_at in descending order." } ] }, "docs": "Get List of APIs.By default the returned apis will be sorted by created_at field in descending order but this can be changed via sort query parameter.The apis returned are paginated" }, { "info": { "name": "Create API Definition", "type": "http" }, "http": { "method": "POST", "url": "http://localhost/api/apis", "params": [ { "name": "base_api_id", "value": "663a4ed9b6be920001b191ae", "type": "query", "description": "The base API which the new version will be linked to." }, { "name": "base_api_version_name", "value": "Default", "type": "query", "description": "The version name of the base API while creating the first version. This doesn't have to be sent for the next versions but if it is set, it will override base API version name." }, { "name": "new_version_name", "value": "v2", "type": "query", "description": "The version name of the created version." }, { "name": "set_default", "value": "true", "type": "query", "description": "If true, the new version is set as default version." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an API Definition in Tyk Classic API format.\n Note that the response includes the newly created Tyk Classic API Definition containing the unique identifier for the APIs (`api_id`). You can provide a value for the `api_id` in the request body, otherwise Tyk will automatically generate a value for you.\n The `ID` field within the Tyk Classic API Definition is a proprietary field used by Tyk to identify the API within the database and cannot be chosen or modified by the user." }, { "info": { "name": "Get API access rights (users and userGroups)", "type": "http" }, "http": { "method": "GET", "url": "http://localhost/api/apis/:apiID/access", "params": [ { "name": "apiID", "value": "b84fe1a04e5648927971c0557971565c", "type": "path", "description": "The API ID" } ] }, "docs": "This will return APIAccessManagementPayload that has two lists containing users and user groups that have access to an API." }, { "info": { "name": "Update API access rights (users and userGroups)", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost/api/apis/:apiID/access", "params": [ { "name": "apiID", "value": "b84fe1a04e5648927971c0557971565c", "type": "path", "description": "The API ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This will update the user group and users that have access to an API.The userIds and userGroup sent will entirely replace the existing userIds IDs and userGroup ids." }, { "info": { "name": "Get a single API by ID", "type": "http" }, "http": { "method": "GET", "url": "http://localhost/api/apis/:apiId", "params": [ { "name": "apiId", "value": "b84fe1a04e5648927971c0557971565c", "type": "path", "description": "ID of API to get. Can either be internal or public API ID." } ] }, "docs": "Get an API by ID" }, { "info": { "name": "Update API Definition", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost/api/apis/:apiId", "params": [ { "name": "apiId", "value": "b84fe1a04e5648927971c0557971565c", "type": "path", "description": "ID of API to get. Can either be internal or public API ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an API Definition. api_id can be updated for On-Premise installations, but it cannot be updated when the Dashboard resides in Tyk Cloud. Updates to api_id in Tyk Cloud will be ignored." }, { "info": { "name": "Delete a single API by ID", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost/api/apis/:apiId", "params": [ { "name": "apiId", "value": "b84fe1a04e5648927971c0557971565c", "type": "path", "description": "ID of API to delete. Can either be internal or public API ID." } ] }, "docs": "Delete an API by ID" }, { "info": { "name": "Get API URLs", "type": "http" }, "http": { "method": "GET", "url": "http://localhost/api/apis/:apiId/url", "params": [ { "name": "apiId", "value": "b84fe1a04e5648927971c0557971565c", "type": "path", "description": "The API ID" } ] }, "docs": "This will return your API BasePath(your API listen path) ,Host(your API domain or gateway hostname ) and API URL (full url to your API upstream which is a combination of the protocol the API uses (e.g http)+ host name(e.g tyk.io) and the API listen_path )" }, { "info": { "name": "Get API Categories", "type": "http" }, "http": { "method": "GET", "url": "http://localhost/api/apis/categories" }, "docs": "Get a list of all the defined API categories and the number(count) of APIs that are in each category." }, { "info": { "name": "Get API Groups.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost/api/apis/groups" }, "docs": "This will return a map/hashmap with categories as keys and the key values will be a list that contains all the APIIDs that belong to that category." }, { "info": { "name": "Search List of APIs", "type": "http" }, "http": { "method": "GET", "url": "http://localhost/api/apis/search", "params": [ { "name": "p", "value": "1", "type": "query", "description": "Use p query parameter to say which page you want returned. Send number less than 0 to return all items." }, { "name": "q", "value": "Rate Limit Path API 1", "type": "query", "description": "The name of the APIs you want to search" } ] }, "docs": "This will return a list of APIs whose names matches the provided q query parameter.If q is not sent all APIs will be returned.The returned results are paginated." }, { "info": { "name": "Get a list of example API definitions.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost/api/examples", "headers": [ { "name": "x-tyk-examples-index", "value": "https://raw.githubusercontent.com/TykTechnologies/tyk-examples/main/repository.json" } ] }, "docs": "Returns a list of all example API definitions available in \"repository.json\" file defined in \"x-tyk-examples-index\" header. If the header is not provided, Tyk will use the default value of this header which is `tyk-examples` repo." }, { "info": { "name": "Get details of a single example API definition.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost/api/examples/:location", "headers": [ { "name": "x-tyk-examples-index", "value": "https://raw.githubusercontent.com/TykTechnologies/tyk-examples/main/repository.json" }, { "name": "x-tyk-repo-url", "value": "https://github.com/TykTechnologies/tyk-examples.git" } ], "params": [ { "name": "location", "value": "udg/vat-checker", "type": "path", "description": "Location of the tyk example in the repository defined in `x-tyk-repo-url`." }, { "name": "readme", "value": "false", "type": "query", "description": "If set to true, the response will contain the content of the Readme file for the specified example, the readme content will be present as the `readme` field." }, { "name": "apiDef", "value": "false", "type": "query", "description": "If set to true, the response will contain the APIDefinition of the specified example, the definition will be present as the `apiDefinition` field." } ] }, "docs": "Get the details of a single API definition, details include full name, location in the repository, description, features and min tyk version." } ] } ], "bundled": true }