Skip to main content
POST
/
providers
Create a new API Provider
curl --request POST \
  --url http://localhost:3001/portal-api/providers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Configuration": {
    "MetaData": "{\"URL\":\"http://localhost:3002\",\"Secret\":\"04d31017802f482f76414a372db30fc2\",\"OrgID\":\"5e9d9544a1dcd60001d0ed20\",\"Gateway\":\"\",\"PoliciesTags\":[],\"InsecureSkipVerify\":false}"
  },
  "Name": "Tyk Dashboard",
  "Type": "tyk-pro"
}
'
{
  "LastSyncedAt": "7 minutes 5 seconds ago",
  "ID": 1,
  "Name": "Tyk Dashboard",
  "Status": "Up",
  "Type": "tyk-pro",
  "Configuration": {
    "MetaData": "{\"URL\":\"http://localhost:3002\",\"Secret\":\"04d31017802f482f76414a372db30fc2\",\"OrgID\":\"5e9d9544a1dcd60001d0ed20\",\"Gateway\":\"\",\"PoliciesTags\":[],\"InsecureSkipVerify\":false}",
    "ID": 1
  },
  "UpdatedAt": "2023-06-23 19:13",
  "CreatedAt": "2023-06-23 19:13"
}

Authorizations

​
Authorization
string
header
required

Body

application/json
​
Configuration
object
​
Name
string

Name of this API Provider

Example:

"Tyk Dashboard"

​
Type
string

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

Example:

"tyk-pro"

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"

​
Configuration
object
​
UpdatedAt
string

When this API Provider was updated the last time

Example:

"2023-06-23 19:13"

​
CreatedAt
string

When this API Provider was created

Example:

"2023-06-23 19:13"