Sign in

v8

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-214977372.7 KB
Account Management API
URL endpoints

Get URL‑endpoint

Note: This API is currently in beta.
Retrieves the URL‑endpoint identified by id.

get/v1/accounts/url-endpoints/{id}

Path parameters

idstring required

Unique identifier for the URL-endpoint. This is generated by ImageKit when you create a new URL-endpoint. For the default URL-endpoint, this is always default.

Unique identifier for the URL-endpoint. This is generated by ImageKit when you create a new URL-endpoint. For the default URL-endpoint, this is always default.

Response

Successful response.

descriptionstring required

Description of the URL endpoint.

urlPrefixstring required

Path segment appended to your base URL to form the endpoint (letters, digits, and hyphens only — or empty for the default endpoint).

originsstring[] required

Ordered list of origin IDs to try when the file isn’t in the Media Library; ImageKit checks them in the sequence provided. Origin must be created before it can be used in a URL endpoint.

idstring required

Unique identifier for the URL-endpoint. This is generated by ImageKit when you create a new URL-endpoint. For the default URL-endpoint, this is always default.

Example response

{
  "description": "My custom URL endpoint",
  "urlPrefix": "product-images",
  "origins": [
    "origin-id-1",
    "origin-id-2"
  ],
  "urlRewriter": {
    "preserveAssetDeliveryTypes": true
  }
}