Skip to main content
GET
/
api
/
apis
/
oas
/
{apiId}
/
urls
Get OAS API server URLs.
curl --request GET \
  --url https://{tenant}/api/apis/oas/{apiId}/urls \
  --header 'Authorization: Bearer <token>'
{
  "api_id": "4c1c0d8fc885401053ddac4e39ef676b",
  "urls": [
    {
      "protocol": "http",
      "domain": "localhost",
      "port": 8080,
      "listen_path": "my-api",
      "endpoint_path": "",
      "query_parameters": [],
      "headers": [],
      "url": "http://localhost:8080/my-api"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Path Parameters

​
apiId
string
required

ID of the API for which you want to retrieve server URLs.

Response

Successfully retrieved server URLs.

Response containing Tyk-generated server URLs for a Tyk OAS API

​
api_id
string
required

The ID of the API

Example:

"4c1c0d8fc885401053ddac4e39ef676b"

​
urls
object[]
required

Array of URL components for each Tyk-generated server URL