Skip to main content
GET
Retrieve an asset.

Authorizations

Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Path Parameters

assetID
string
required

ID of the asset to retrieve - this value can be the database ID of the asset or the custom ID provided during creation/update.

Response

Asset fetched.

_id
string
read-only

database id of asset

Example:

"659b9613a1ed7ef7afdccb9d"

data
any

A raw JSON value. An oas-template asset holds an OAS document; a fragment asset may hold any JSON value except null - an object, an array, a string, a number or a boolean.

Example:
description
string
id
string

custom id of asset that can be provided while creation/updating.

Example:

"my-unique-template-id"

kind
enum<string>
default:oas-template

the asset type

Available options:
oas-template,
fragment
Example:

"oas-template"

last_updated
string<date-time>
read-only

last updated time stamp

Example:

"2024-01-10T08:48:36.183Z"

name
string

human-readable name for the template

org_id
string
tags
string[]

Labels used to find and filter fragments. Fragments only; sent on any other kind of asset, the request is rejected with 422. Before a tag is stored, surrounding whitespace and a leading "#" are removed, it is lowercased, and empty and duplicate tags are dropped, so "#Security" is stored as "security". The result may contain only ASCII letters, digits, "-" and "_", and be at most 64 characters; any other tag rejects the request with 422.

Example: