Get OAS API server URLs.

Get the Tyk generated server URLs for a Tyk OAS API. This endpoint returns structured URL information including decomposed components (protocol, domain, listen path, version path, query parameters, and headers) for all server URLs that Tyk generates for the API.

GET /api/apis/oas/{apiId}/urls

Try it

Get OAS API server URLs.

cURL

curl --request GET \
  --url https://{tenant}/api/apis/oas/{apiId}/urls \
  --header 'Authorization: Bearer <token>'

200

{
  "api_id": "4c1c0d8fc885401053ddac4e39ef676b",
  "urls": [
    {
      "protocol": "https",
      "domain": "api.example.com",
      "listen_path": "my-api",
      "url": "https://api.example.com/my-api/v1",
      "port": 8080,
      "endpoint_path": "v1",
      "query_parameters": [
        {
          "name": "version",
          "value": "v1"
        }
      ],
      "headers": [
        {
          "name": "X-API-Version",
          "value": "v1"
        }
      ]
    }
  ]
}

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

200

application/json

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

Show child attributes

urls. protocol · string · required

HTTP scheme (http or https)

Example:

"https"

urls. domain · string · required

Hostname (gateway domain or custom domain if configured)

Example:

"api.example.com"

urls. listen_path · string · required

Base path from API configuration

Example:

"my-api"

urls. url · string · required

Complete reconstructed URL

Example:

"https://api.example.com/my-api/v1"

urls. port · integer | null

Port number (null for standard ports 80/443)

Example:

8080

urls. endpoint_path · string

Version-specific path segment (e.g., "v1", "v2"), empty for non-versioned or header/query param versioned APIs

Example:

"v1"

urls. query_parameters · object[]

Query parameters required for version routing (populated for url-param versioning)

Show child attributes

urls.query_parameters. name · string · required

Query parameter name (e.g., "version")

Example:

"version"

urls.query_parameters. value · string · required

Query parameter value (e.g., "v1")

Example:

"v1"

urls. headers · object[]

Headers required for version routing (populated for header versioning)

Show child attributes

urls.headers. name · string · required

Header name (e.g., "X-API-Version")

Example:

"X-API-Version"

urls.headers. value · string · required

Header value (e.g., "v1")

Example:

"v1"