Utility

Prefetch brand data

Changed on

Queue brand or styleguide data so a later lookup can return sooner.

post/utility/prefetch

Request

  • Base URL: https://api.context.dev/v1
  • URL: https://api.context.dev/v1/utility/prefetch
  • Auth: HTTP bearer

Request body

type'brand' | 'styleguide' required

Data to prefetch.

tagsstring[]

Labels for filtering usage in the dashboard.

Example request

{
  "tags": [
    "production",
    "team-alpha"
  ]
}

Response

Successful response

statusstring

Always ok on success.

messagestring

Success message

type'brand' | 'styleguide'

The type of prefetch that was queued, echoed from the request

domainstring

The domain that was queued for prefetching

request_idstring uuid required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example response

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"
}

Changes

  • 61627728926bRevision changes
    • warning

      added the new NO_PUBLISHED_MARKDOWN enum value to the response property for the response status

  • aeb64a2b7925Revision changes
    • warning

      added the new USAGE_EXCEEDED enum value to the response property for the response status