{ "info": { "_postman_id": "5869c94a-03da-452c-bf96-74a44f0ab50e", "name": "WSO2 API Manager - Admin Advanced Policy (Collection) Advanced Policy (Collection) Get API Info API", "description": "This document specifies a **RESTful API** for WSO2 **API Manager** - **Admin Portal**.\nPlease see [full OpenAPI Specification](https://raw.githubusercontent.com/wso2/carbon-apimgt/master/components/apimgt/org.wso2.carbon.apimgt.rest.api.admin.v1/src/main/resources/admin-api.yaml) of the API which is written using [OAS 3.0](http://swagger.io/) specification.\n\n# Authentication\nThe Admin REST API is protected using OAuth2 and access control is achieved through scopes. Before you start invoking\nthe the API you need to obtain an access token with the required scopes. This guide will walk you through the steps\nthat you will need to follow to obtain an access token.\nFirst you need to obtain the consumer key/secret key pair by calling the dynamic client registration (DCR) endpoint. You can add your preferred grant types\nin the payload. A sample payload is shown below.\n```\n {\n \"callbackUrl\":\"www.example.com\",\n \"clientName\":\"rest_api_admin\",\n \"owner\":\"admin\",\n \"grantType\":\"client_credentials password refresh_token\",\n \"saasApp\":true\n }\n```\nCreate a file (payload.json) with the above sample payload, and use the cURL shown bellow to invoke the DCR endpoint. Authorization header of this should contain the\nbase64 encoded admin username and password.\n**Format of the request**\n```\n curl -X POST -H \"Authorization: Basic Base64(admin_username:admin_password)\" -H \"Content-Type: application/json\"\n \\ -d @payload.json https://:/client-registration/v0.17/register\n```\n**Sample request**\n```\n curl -X POST -H \"Authorization: Basic YWRtaW46YWRtaW4=\" -H \"Content-Type: application/json\"\n \\ -d @payload.json https://localhost:9443/client-registration/v0.17/register\n```\nFollowing is a sample response after invoking the above curl.\n```\n{\n\"clientId\": \"fOCi4vNJ59PpHucC2CAYfYuADdMa\",\n\"clientName\": \"rest_api_admin\",\n\"callBackURL\": \"www.example.com\",\n\"clientSecret\": \"a4FwHlq0iCIKVs2MPIIDnepZnYMa\",\n\"isSaasApplication\": true,\n\"appOwner\": \"admin\",\n\"jsonString\": \"{\\\"grant_types\\\":\\\"client_credentials password refresh_token\\\",\\\"redirect_uris\\\":\\\"www.example.com\\\",\\\"client_name\\\":\\\"rest_api_admin\\\"}\",\n\"jsonAppAttribute\": \"{}\",\n\"tokenType\": null\n}\n```\nNote that in a distributed deployment or IS as KM separated environment to invoke RESTful APIs (product APIs), users must generate tokens through API-M Control Plane's token endpoint.\nThe tokens generated using third party key managers, are to manage end-user authentication when accessing APIs.\n\nNext you must use the above client id and secret to obtain the access token.\nWe will be using the password grant type for this, you can use any grant type you desire.\nYou also need to add the proper **scope** when getting the access token. All possible scopes for Admin REST API can be viewed in **OAuth2 Security** section\nof this document and scope for each resource is given in **authorizations** section of resource documentation.\nFollowing is the format of the request if you are using the password grant type.\n```\ncurl -k -d \"grant_type=password&username=&password=&scope=\"\n\\ -H \"Authorization: Basic base64(cliet_id:client_secret)\"\n\\ https://:/oauth2/token\n```\n**Sample request**\n```\ncurl https://localhost:9443/oauth2/token -k \\\n-H \"Authorization: Basic Zk9DaTR2Tko1OVBwSHVjQzJDQVlmWXVBRGRNYTphNEZ3SGxxMGlDSUtWczJNUElJRG5lcFpuWU1h\" \\\n-d \"grant_type=password&username=admin&password=admin&scope=apim:admin apim:tier_view\"\n```\nShown below is a sample response to the above request.\n```\n{\n\"access_token\": \"e79bda48-3406-3178-acce-f6e4dbdcbb12\",\n\"refresh_token\": \"a757795d-e69f-38b8-bd85-9aded677a97c\",\n\"scope\": \"apim:admin apim:tier_view\",\n\"token_type\": \"Bearer\",\n\"expires_in\": 3600\n}\n```\nNow you have a valid access token, which you can use to invoke an API.\nNavigate through the API descriptions to find the required API, obtain an access token as described above and invoke the API with the authentication header.\nIf you use a different authentication mechanism, this process may change.\n\n# Try out in Postman\nIf you want to try-out the embedded postman collection with \"Run in Postman\" option, please follow the guidelines listed below.\n* All of the OAuth2 secured endpoints have been configured with an Authorization Bearer header with a parameterized access token. Before invoking any REST API resource make sure you run the `Register DCR Application` and `Generate Access Token` requests to fetch an access token with all required scopes.\n* Make sure you have an API Manager instance up and running.\n* Update the `basepath` parameter to match the hostname and port of the APIM instance.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/32294946-71bea2bc-f808-4208-a4f6-861ede6f0434)\n\n\nContact Support:\n Name: WSO2\n Email: architecture@wso2.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:35:39.000Z", "updatedAt": "2026-07-28T03:35:39.000Z", "lastUpdatedBy": "35240", "uid": "35240-5869c94a-03da-452c-bf96-74a44f0ab50e" }, "item": [ { "name": "apis", "item": [ { "name": "{apiId}", "item": [ { "name": "Get the subscription information of an API by providing the API uuid.", "id": "31ec7b7e-9543-4946-92c3-2d751cb56291", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/apis/:apiId?tenantDomain=", "host": [ "{{baseUrl}}" ], "path": [ "apis", ":apiId" ], "query": [ { "description": "Tenant Domain of the API\n", "key": "tenantDomain", "value": "" } ], "variable": [ { "id": "134eb45d-7f89-42db-b2f1-7b4fd7a9d017", "key": "apiId", "value": "", "description": "(Required) API ID of the API\n" } ] }, "description": "This operation is used to get the subscription information of an API from storage. If the Tenant domain is not provided\ncarbon.super will be picked as the Tenant domain.\n" }, "response": [ { "id": "d2b3d766-4d68-432d-bd02-a846ac743b3b", "name": "OK.\nAPIS successfully retrieved from the storage for the API.\n", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/apis/:apiId?tenantDomain=", "host": [ "{{baseUrl}}" ], "path": [ "apis", ":apiId" ], "query": [ { "description": "Tenant Domain of the API\n", "key": "tenantDomain", "value": "" } ], "variable": [ { "key": "apiId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:35:39.000Z", "updatedAt": "2026-07-28T03:35:39.000Z", "uid": "35240-d2b3d766-4d68-432d-bd02-a846ac743b3b" }, { "id": "11dcf43f-660c-49db-98c9-d788f7803a5f", "name": "400 response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/apis/:apiId?tenantDomain=", "host": [ "{{baseUrl}}" ], "path": [ "apis", ":apiId" ], "query": [ { "description": "Tenant Domain of the API\n", "key": "tenantDomain", "value": "" } ], "variable": [ { "key": "apiId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:35:39.000Z", "updatedAt": "2026-07-28T03:35:39.000Z", "uid": "35240-11dcf43f-660c-49db-98c9-d788f7803a5f" }, { "id": "35551ace-673e-44ea-8ca6-dcfc3d833c0a", "name": "404 response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/apis/:apiId?tenantDomain=", "host": [ "{{baseUrl}}" ], "path": [ "apis", ":apiId" ], "query": [ { "description": "Tenant Domain of the API\n", "key": "tenantDomain", "value": "" } ], "variable": [ { "key": "apiId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:35:39.000Z", "updatedAt": "2026-07-28T03:35:39.000Z", "uid": "35240-35551ace-673e-44ea-8ca6-dcfc3d833c0a" } ], "createdAt": "2026-07-28T03:35:39.000Z", "updatedAt": "2026-07-28T03:35:39.000Z", "uid": "35240-31ec7b7e-9543-4946-92c3-2d751cb56291" } ], "id": "85ce8518-5db4-4f66-929c-42bb3588c8fd", "createdAt": "2026-07-28T03:35:39.000Z", "updatedAt": "2026-07-28T03:35:39.000Z", "uid": "35240-85ce8518-5db4-4f66-929c-42bb3588c8fd" }, { "name": "Get the list of APIS by providing context and version.", "id": "a9dac0df-84b2-4188-872c-d7fcb501263b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/apis?context=&version=&tenantDomain=", "host": [ "{{baseUrl}}" ], "path": [ "apis" ], "query": [ { "description": "Context of the API\n", "key": "context", "value": "" }, { "description": "version of the API\n", "key": "version", "value": "" }, { "description": "Tenant Domain of the API\n", "key": "tenantDomain", "value": "" } ] }, "description": "This operation is used to get the API information from storage. If the Tenant domain is not provided\ncarbon.super will be picked as the Tenant domain.\n" }, "response": [ { "id": "674873ee-2729-49d9-9e59-84fe282a4e8a", "name": "OK.\nAPIS successfully retrieved from the storage for the API.\n", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/apis?context=&version=&tenantDomain=", "host": [ "{{baseUrl}}" ], "path": [ "apis" ], "query": [ { "description": "Context of the API\n", "key": "context", "value": "" }, { "description": "version of the API\n", "key": "version", "value": "" }, { "description": "Tenant Domain of the API\n", "key": "tenantDomain", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:35:39.000Z", "updatedAt": "2026-07-28T03:35:39.000Z", "uid": "35240-674873ee-2729-49d9-9e59-84fe282a4e8a" }, { "id": "17993dd1-08fc-46c4-a62e-a0044ddafa00", "name": "400 response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/apis?context=&version=&tenantDomain=", "host": [ "{{baseUrl}}" ], "path": [ "apis" ], "query": [ { "description": "Context of the API\n", "key": "context", "value": "" }, { "description": "version of the API\n", "key": "version", "value": "" }, { "description": "Tenant Domain of the API\n", "key": "tenantDomain", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:35:39.000Z", "updatedAt": "2026-07-28T03:35:39.000Z", "uid": "35240-17993dd1-08fc-46c4-a62e-a0044ddafa00" }, { "id": "4a3818f9-4d4e-4a45-b5aa-73f0467605f5", "name": "404 response", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/apis?context=&version=&tenantDomain=", "host": [ "{{baseUrl}}" ], "path": [ "apis" ], "query": [ { "description": "Context of the API\n", "key": "context", "value": "" }, { "description": "version of the API\n", "key": "version", "value": "" }, { "description": "Tenant Domain of the API\n", "key": "tenantDomain", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:35:39.000Z", "updatedAt": "2026-07-28T03:35:39.000Z", "uid": "35240-4a3818f9-4d4e-4a45-b5aa-73f0467605f5" } ], "createdAt": "2026-07-28T03:35:39.000Z", "updatedAt": "2026-07-28T03:35:39.000Z", "uid": "35240-a9dac0df-84b2-4188-872c-d7fcb501263b" } ], "id": "9eabd812-d112-4d2b-bb02-17092f90dfa0", "createdAt": "2026-07-28T03:35:39.000Z", "updatedAt": "2026-07-28T03:35:39.000Z", "uid": "35240-9eabd812-d112-4d2b-bb02-17092f90dfa0" } ], "variable": [ { "key": "baseUrl", "value": "https://apis.wso2.com/api/am/admin/v4" } ] }