Skip to main content
GET
/
providers
List all API Providers
curl --request GET \
  --url http://localhost:3001/portal-api/providers \
  --header 'Authorization: <api-key>'
[
  {
    "LastSyncedAt": "7 minutes 5 seconds ago",
    "ID": 1,
    "Name": "Tyk Dashboard",
    "Status": "Up",
    "Type": "tyk-pro"
  }
]

Authorizations

​
Authorization
string
header
required

Query Parameters

​
limit
integer

Maximum number of records to return for this request. Overrides the row count only, not the page offset (which is always based on per_page), so use per_page for pagination rather than combining limit with page. Defaults to the per_page value.

​
per_page
integer
default:20

Items per page. Defaults to the resource-specific page count if configured, otherwise 20

​
page
integer
default:1

Page number. Defaults to 1 when omitted

Response

200 - application/json

OK

​
LastSyncedAt
string

The last time this provider was synchronized with the portal

Example:

"7 minutes 5 seconds ago"

​
ID
integer

UUID of this API provider in the portal's database

Example:

1

​
Name
string

Name of this API Provider

Example:

"Tyk Dashboard"

​
Status
string

Identifies if this API Provider is Up and ready for synchronization

Example:

"Up"

​
Type
string

Type of API gateway used by this API Provider e.g. Tyk or AWS

Example:

"tyk-pro"