Skip to main content
GET
Retrieve list of assets.

Authorizations

​
Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Query Parameters

​
kind
enum<string>

Filter assets by kind (optional).

Available options:
oas-template,
fragment
​
paginated
boolean
default:false

Set to true to return the paginated {assets, pages} object. When missing or false, a bare array of every matching asset is returned and q, p and sort are ignored.

​
q
string

Only applies with paginated=true. Case-insensitive substring match on the asset name. The value is matched literally, except that on SQL storage % and _ act as wildcards and \ escapes the next character.

​
p
integer
default:1

Only applies with paginated=true. Page number, starting at 1. Send -1 to return every matching asset on one page.

​
sort
enum<string>
default:-created_at

Only applies with paginated=true. Field to sort by, prefixed with - for descending order, as on GET /api/apis. Name sorts are case-insensitive. Unknown values fall back to the default, newest created first.

Available options:
name,
-name,
updated_at,
-updated_at,
created_at,
-created_at
​
tags
string[]

Filter fragments by tag (optional). Accepts a comma separated list, or the parameter repeated, and returns the fragments carrying any one of the tags. Matching is case-insensitive and a leading "#" is ignored, so "#Security" matches "security". Omitted, no tag filter is applied.

Response

Assets 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: