> ## Documentation Index > Fetch the complete documentation index at: https://tyk.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /swagger/5.12/dashboard-swagger.yml get /api/apis/oas/{apiId}/urls openapi: 3.0.3 info: contact: email: support@tyk.io name: Tyk Technologies url: https://tyk.io/contact description: > ## Introduction The Tyk Dashboard API offers granular, programmatic access to a centralised database of resources that your Tyk nodes can pull from. This API has a dynamic user administrative structure which means the secret key that is used to communicate with your Tyk nodes can be kept secret and access to the wider management functions can be handled on a user-by-user and organisation-by-organisation basis. A common question around using a database-backed configuration is how to programmatically add API definitions to your Tyk nodes, the Dashboard API allows much more fine-grained, secure and multi-user access to your Tyk cluster, and should be used to manage a database-backed Tyk node. The Tyk Dashboard API works seamlessly with the Tyk Dashboard (and the two come bundled together). ## Security Hierarchy The Dashboard API provides a more structured security layer to managing Tyk nodes. ### Organisations, APIs and Users With the Dashboard API and a database-backed Tyk setup, (and to an extent with file-based API setups - if diligence is used in naming and creating definitions), the following security model is applied to the management of Upstream APIs: * **Organisations**: All APIs are *owned* by an organisation, this is designated by the 'OrgID' parameter in the API Definition. * **Users**: All users created in the Dashboard belong to an organisation (unless an exception is made for super-administrative access). * **APIs**: All APIs belong to an Organisation and only Users that belong to that organisation can see the analytics for those APIs and manage their configurations. * **API Keys**: API Keys are designated by organisation, this means an API key that has full access rights will not be allowed to access the APIs of another organisation on the same system, but can have full access to all APIs within the organisation. * **Access Rights**: Access rights are stored with the key, this enables a key to give access to multiple APIs, this is defined by the session object in the core Tyk API. In order to use the Dashboard API, you'll need to get the 'Tyk Dashboard API Access Credentials' secret from your user profile on the Dashboard UI. The secret you set should then be sent along as a header with each Dashboard API Request in order for it to be successful: authorization: license: name: Mozilla Public License Version 2.0 url: https://github.com/TykTechnologies/tyk/blob/master/LICENSE.md title: Tyk Dashboard API version: 5.11.0 servers: - url: https://{tenant} variables: tenant: default: localhost:3000 description: Your dashboard host security: - bearerAuth: [] tags: - description: >- Use the endpoints under this tag to manage your certificates. You can add, delete and list certificates using these endpoints. name: Certificates - description: >- The Tyk Dashboard provides a full set of analytics functions and graphs that you can use to segment and view your API traffic and activity. externalDocs: description: Traffic Analytics. url: https://tyk.io/docs/tyk-dashboard-analytics/ name: Analytics - description: Use the endpoints in this tag to manage OAuth flow. externalDocs: description: OAuth Documentation url: >- https://tyk.io/docs/basic-config-and-security/security/authentication-authorization/oauth-2-0/ name: Oauth - description: > An API template is an asset managed by Tyk Dashboard that is used as the starting point - a blueprint - from which you can create a new Tyk OAS API definition.
Templates are used only during the creation of an API, they cannot be applied later. [Read more about API template assets here](https://tyk.io/docs/product-stack/tyk-dashboard/advanced-configurations/templates/template-overview/) externalDocs: description: API Templates full documentation. url: >- https://tyk.io/docs/product-stack/tyk-dashboard/advanced-configurations/templates/template-overview/ name: Assets - description: > The Tyk Dashboard permission system can be extended by writing custom rules using an Open Policy Agent (OPA). The rules engine works on top of your Dashboard API, which means you can control not only access rules, but also behaviour of all Dashboard APIs (except your public developer portal)
By default the Dashboard OPA engine is turned off, and you need to explicitly enable it via your Dashboard tyk_analytics.conf file.
You can use OPA rule to accomplish tasks like:
1. Prevent users from creating keyless APIs. 2. Assign specific categories to APIs created to certain user groups or users. 3. Control access for individual fields. For example, do not allow changing the API “active” status (e.g. deploy), unless you have a specific permission set. 4. And many more
[Read more about Tyk Open Policy Agent here](https://tyk.io/docs/tyk-dashboard/open-policy-agent/) externalDocs: description: Tyk Open Policy Agent Full Documentation. url: https://tyk.io/docs/tyk-dashboard/open-policy-agent/ name: Open Policy Agent - description: > These APIs helps you get,add and delete (CRUD) a list of additional (custom) permissions for your Dashboard users. You can use the created additional permissions with Open Policy Agent (OPA).
Once created, a custom permission will be added to standard list of user permissions.
You can also configure these custom permissions in the security.additional_permissions map in the Tyk Dashboard configuration file. You can check the [full documentation here](https://tyk.io/docs/tyk-dashboard-api/org/permissions/). externalDocs: description: Additional Permissions full documentation. url: https://tyk.io/docs/tyk-dashboard-api/org/permissions/ name: Additional Permissions - description: Get schemas. name: Schemas - description: > Webhooks are a great way to let external applications know about the status of a user, an API or an event that has occurred in the Tyk gateway
You can create webhooks that you can then re-use in your API definitions and assign to different Tyk Events such as quota violations or rate-limiting violations.
Each webhook require a target_path (which is an absolute URL that should be targeted by the webhook e.g https://httpbin.org/expired-keys) and a method which can be any of GET, PUT, POST, PATCH or DELETE.
Request types that do not support an encoded body will not have the event metadata encoded as part of the request. We would advise using POST where possible. name: Webhooks - description: >- Policies are a template that enable you to create access rules, usage quota and rate limits that can be applied to multiple keys. They are a useful way to manage large groups of users, and to enforce quota changes on a global scale across any number of keys that are using a policy. When used in conjunction with the portal, developers that enroll for API access will be given a key that is attached to a specific policy. The policy settings are refreshed every time a key attempts access, meaning that updating a policy will have an effect across any keys that are attached to it. externalDocs: description: Security Policies Documentation. url: >- https://tyk.io/docs/basic-config-and-security/security/security-policies/ name: Policies - description: >- When you have a large number of users and teams with different access requirements, instead of setting permissions per user, you can create a user group and configure the permissions for all users in the group. Note that a user can only belong to one group. externalDocs: description: Manage Tyk Dashboard User Groups. url: >- https://tyk.io/docs/basic-config-and-security/security/dashboard/create-user-groups/ name: UserGroup - description: >- Users have twofold access to the dashboard: they can access both the Dashboard API and the Dashboard itself, it is possible to generate users that have read-only access to certain sections of the dashboard and the underlying API. Use the endpoints in this tag to manage users. externalDocs: description: Manage Tyk Dashboard Users. url: >- https://tyk.io/docs/basic-config-and-security/security/dashboard/create-users/ name: Users - description: >- All keys that are used to access services via Tyk correspond to a session object that informs Tyk about the context of this particular token, like access rules and rate/quota allowance. externalDocs: description: API Key Management. url: https://tyk.io/docs/tyk-apis/tyk-dashboard-api/api-keys/ name: Keys - description: >- An API request made using Basic Authentication will have an Authorization header that contains the API key. The value of the Authorization header will be in the form:
`Basic base64Encode(username:password)`. externalDocs: description: Basic Authentication. url: >- https://tyk.io/docs/basic-config-and-security/security/authentication-authorization/basic-auth/ name: Basic Authentication - description: >- Tyk allows you to work with APIs that you’ve designed with the OpenAPI Specification version 3.0.x, making it even easier to get your API up and running. Use the endpoints in this tag to create,delete,import and update OAS APIs. externalDocs: description: Tyk OAS Documentation. url: https://tyk.io/docs/getting-started/key-concepts/high-level-concepts/ name: OAS APIs - description: >- Use the endpoints under this tags to update,add ,delete and fetch the classic APIs. name: APIs - description: >- The Dashboard SSO API allows you to implement custom authentication schemes for the Dashboard and Portal. Our Tyk Identity Broker (TIB) internally also uses this API. The Dashboard exposes the /api/sso Dashboard API which allows you to generate a temporary authentication token, valid for 60 seconds. externalDocs: description: Dashboard API Single Sign On. url: https://tyk.io/docs/tyk-apis/tyk-dashboard-api/sso/ name: Single Sign On - description: System API. name: System - description: Notifications for an organisation name: Organisation Notifications paths: /api/apis/oas/{apiId}/urls: get: tags: - OAS APIs summary: Get OAS API server URLs. description: > 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. operationId: getOASServerURLs parameters: - description: ID of the API for which you want to retrieve server URLs. example: 4c1c0d8fc885401053ddac4e39ef676b in: path name: apiId required: true schema: type: string responses: '200': content: application/json: examples: nonVersionedAPI: summary: Non-versioned API description: Simple API without versioning returns a single server URL value: 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 versionedAPIUrlPath: summary: URL path versioning description: Base API with URL path versioning (location=url) value: api_id: 5d2e3f4a6b7c8d9e0f1a2b3c urls: - protocol: https domain: api.example.com port: null listen_path: users endpoint_path: v1 query_parameters: [] headers: [] url: https://api.example.com/users/v1 - protocol: https domain: api.example.com port: null listen_path: users endpoint_path: '' query_parameters: [] headers: [] url: https://api.example.com/users versionedAPIQueryParam: summary: Query parameter versioning description: >- Base API with query parameter versioning (location=url-param) value: api_id: 6e3f4g5h7i8j9k0l1m2n3o4p urls: - protocol: https domain: gateway.tyk.io port: null listen_path: products endpoint_path: '' query_parameters: - name: version value: v1 headers: [] url: https://gateway.tyk.io/products?version=v1 versionedAPIHeader: summary: Header versioning description: Base API with header-based versioning (location=header) value: api_id: 7f4g5h6i8j9k0l1m2n3o4p5q urls: - protocol: https domain: api.company.com port: null listen_path: orders endpoint_path: '' query_parameters: [] headers: - name: X-API-Version value: v1 url: https://api.company.com/orders externalChildAPI: summary: External child API (v2) description: >- External child API exposes both versioned path and direct path value: api_id: 8g5h6i7j9k0l1m2n3o4p5q6r urls: - protocol: https domain: api.example.com port: null listen_path: users endpoint_path: v2 query_parameters: [] headers: [] url: https://api.example.com/users/v2 - protocol: https domain: api.example.com port: null listen_path: users-v2 endpoint_path: '' query_parameters: [] headers: [] url: https://api.example.com/users-v2 customDomain: summary: Custom domain configuration description: API with custom domain configured value: api_id: 9h6i7j8k0l1m2n3o4p5q6r7s urls: - protocol: https domain: custom.domain.com port: null listen_path: api endpoint_path: '' query_parameters: [] headers: [] url: https://custom.domain.com/api schema: $ref: '#/components/schemas/OASServerURLsResponse' description: Successfully retrieved server URLs. '400': content: application/json: example: Message: API ID is required Meta: null Status: Error schema: $ref: '#/components/schemas/ApiResponse' description: Bad request. API ID is missing or invalid. '401': content: application/json: example: Message: Not authorised Meta: null Status: Error schema: $ref: '#/components/schemas/ApiResponse' description: Unauthorized. Invalid or missing authorization credentials. '403': content: application/json: example: Message: >- access denied: You do not have permission to access /api/apis/oas/{apiId}/urls Meta: null Status: Error schema: $ref: '#/components/schemas/ApiResponse' description: Forbidden. User does not have permission to access this API. '404': content: application/json: example: Message: API not found Meta: null Status: Error schema: $ref: '#/components/schemas/ApiResponse' description: API not found. The specified API ID does not exist. '500': content: application/json: example: Message: Failed to generate server URLs Meta: null Status: Error schema: $ref: '#/components/schemas/ApiResponse' description: Internal server error. Failed to generate or parse server URLs. components: schemas: OASServerURLsResponse: description: Response containing Tyk-generated server URLs for a Tyk OAS API properties: api_id: description: The ID of the API type: string example: 4c1c0d8fc885401053ddac4e39ef676b urls: description: Array of URL components for each Tyk-generated server URL type: array items: $ref: '#/components/schemas/URLComponents' required: - api_id - urls type: object x-go-package: github.com/TykTechnologies/tyk-analytics/dashboard ApiResponse: properties: ID: type: string Message: type: string Meta: {} Status: type: string type: object URLComponents: description: >- Decomposed components of a server URL including protocol, domain, paths, and versioning information properties: protocol: description: HTTP scheme (http or https) type: string example: https domain: description: Hostname (gateway domain or custom domain if configured) type: string example: api.example.com port: description: Port number (null for standard ports 80/443) type: integer nullable: true example: 8080 listen_path: description: Base path from API configuration type: string example: my-api endpoint_path: description: >- Version-specific path segment (e.g., "v1", "v2"), empty for non-versioned or header/query param versioned APIs type: string example: v1 query_parameters: description: >- Query parameters required for version routing (populated for url-param versioning) type: array items: $ref: '#/components/schemas/QueryParameter' headers: description: >- Headers required for version routing (populated for header versioning) type: array items: $ref: '#/components/schemas/HeaderParameter' url: description: Complete reconstructed URL type: string example: https://api.example.com/my-api/v1 required: - protocol - domain - listen_path - url type: object x-go-package: github.com/TykTechnologies/tyk-analytics/dashboard QueryParameter: description: Query parameter name-value pair properties: name: description: Query parameter name (e.g., "version") type: string example: version value: description: Query parameter value (e.g., "v1") type: string example: v1 required: - name - value type: object x-go-package: github.com/TykTechnologies/tyk-analytics/dashboard HeaderParameter: description: HTTP header name-value pair properties: name: description: Header name (e.g., "X-API-Version") type: string example: X-API-Version value: description: Header value (e.g., "v1") type: string example: v1 required: - name - value type: object x-go-package: github.com/TykTechnologies/tyk-analytics/dashboard securitySchemes: bearerAuth: description: The Tyk Dashboard API Access Credentials scheme: bearer type: http ````