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"
}
'import requests
url = "http://localhost:3001/portal-api/providers"
payload = {
"Configuration": { "MetaData": "{\"URL\":\"http://localhost:3002\",\"Secret\":\"04d31017802f482f76414a372db30fc2\",\"OrgID\":\"5e9d9544a1dcd60001d0ed20\",\"Gateway\":\"\",\"PoliciesTags\":[],\"InsecureSkipVerify\":false}" },
"Name": "Tyk Dashboard",
"Type": "tyk-pro"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Configuration: {
MetaData: '{"URL":"http://localhost:3002","Secret":"04d31017802f482f76414a372db30fc2","OrgID":"5e9d9544a1dcd60001d0ed20","Gateway":"","PoliciesTags":[],"InsecureSkipVerify":false}'
},
Name: 'Tyk Dashboard',
Type: 'tyk-pro'
})
};
fetch('http://localhost:3001/portal-api/providers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/portal-api/providers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Configuration' => [
'MetaData' => '{"URL":"http://localhost:3002","Secret":"04d31017802f482f76414a372db30fc2","OrgID":"5e9d9544a1dcd60001d0ed20","Gateway":"","PoliciesTags":[],"InsecureSkipVerify":false}'
],
'Name' => 'Tyk Dashboard',
'Type' => 'tyk-pro'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3001/portal-api/providers"
payload := strings.NewReader("{\n \"Configuration\": {\n \"MetaData\": \"{\\\"URL\\\":\\\"http://localhost:3002\\\",\\\"Secret\\\":\\\"04d31017802f482f76414a372db30fc2\\\",\\\"OrgID\\\":\\\"5e9d9544a1dcd60001d0ed20\\\",\\\"Gateway\\\":\\\"\\\",\\\"PoliciesTags\\\":[],\\\"InsecureSkipVerify\\\":false}\"\n },\n \"Name\": \"Tyk Dashboard\",\n \"Type\": \"tyk-pro\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3001/portal-api/providers")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Configuration\": {\n \"MetaData\": \"{\\\"URL\\\":\\\"http://localhost:3002\\\",\\\"Secret\\\":\\\"04d31017802f482f76414a372db30fc2\\\",\\\"OrgID\\\":\\\"5e9d9544a1dcd60001d0ed20\\\",\\\"Gateway\\\":\\\"\\\",\\\"PoliciesTags\\\":[],\\\"InsecureSkipVerify\\\":false}\"\n },\n \"Name\": \"Tyk Dashboard\",\n \"Type\": \"tyk-pro\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/portal-api/providers")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Configuration\": {\n \"MetaData\": \"{\\\"URL\\\":\\\"http://localhost:3002\\\",\\\"Secret\\\":\\\"04d31017802f482f76414a372db30fc2\\\",\\\"OrgID\\\":\\\"5e9d9544a1dcd60001d0ed20\\\",\\\"Gateway\\\":\\\"\\\",\\\"PoliciesTags\\\":[],\\\"InsecureSkipVerify\\\":false}\"\n },\n \"Name\": \"Tyk Dashboard\",\n \"Type\": \"tyk-pro\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}Providers
Create a new API Provider
Create a new API Provider. The new API Provider will have the ‘Unknown’ synchronization status until the first synchronization attempt
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"
}
'import requests
url = "http://localhost:3001/portal-api/providers"
payload = {
"Configuration": { "MetaData": "{\"URL\":\"http://localhost:3002\",\"Secret\":\"04d31017802f482f76414a372db30fc2\",\"OrgID\":\"5e9d9544a1dcd60001d0ed20\",\"Gateway\":\"\",\"PoliciesTags\":[],\"InsecureSkipVerify\":false}" },
"Name": "Tyk Dashboard",
"Type": "tyk-pro"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Configuration: {
MetaData: '{"URL":"http://localhost:3002","Secret":"04d31017802f482f76414a372db30fc2","OrgID":"5e9d9544a1dcd60001d0ed20","Gateway":"","PoliciesTags":[],"InsecureSkipVerify":false}'
},
Name: 'Tyk Dashboard',
Type: 'tyk-pro'
})
};
fetch('http://localhost:3001/portal-api/providers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/portal-api/providers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Configuration' => [
'MetaData' => '{"URL":"http://localhost:3002","Secret":"04d31017802f482f76414a372db30fc2","OrgID":"5e9d9544a1dcd60001d0ed20","Gateway":"","PoliciesTags":[],"InsecureSkipVerify":false}'
],
'Name' => 'Tyk Dashboard',
'Type' => 'tyk-pro'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3001/portal-api/providers"
payload := strings.NewReader("{\n \"Configuration\": {\n \"MetaData\": \"{\\\"URL\\\":\\\"http://localhost:3002\\\",\\\"Secret\\\":\\\"04d31017802f482f76414a372db30fc2\\\",\\\"OrgID\\\":\\\"5e9d9544a1dcd60001d0ed20\\\",\\\"Gateway\\\":\\\"\\\",\\\"PoliciesTags\\\":[],\\\"InsecureSkipVerify\\\":false}\"\n },\n \"Name\": \"Tyk Dashboard\",\n \"Type\": \"tyk-pro\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3001/portal-api/providers")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Configuration\": {\n \"MetaData\": \"{\\\"URL\\\":\\\"http://localhost:3002\\\",\\\"Secret\\\":\\\"04d31017802f482f76414a372db30fc2\\\",\\\"OrgID\\\":\\\"5e9d9544a1dcd60001d0ed20\\\",\\\"Gateway\\\":\\\"\\\",\\\"PoliciesTags\\\":[],\\\"InsecureSkipVerify\\\":false}\"\n },\n \"Name\": \"Tyk Dashboard\",\n \"Type\": \"tyk-pro\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/portal-api/providers")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Configuration\": {\n \"MetaData\": \"{\\\"URL\\\":\\\"http://localhost:3002\\\",\\\"Secret\\\":\\\"04d31017802f482f76414a372db30fc2\\\",\\\"OrgID\\\":\\\"5e9d9544a1dcd60001d0ed20\\\",\\\"Gateway\\\":\\\"\\\",\\\"PoliciesTags\\\":[],\\\"InsecureSkipVerify\\\":false}\"\n },\n \"Name\": \"Tyk Dashboard\",\n \"Type\": \"tyk-pro\"\n}"
response = http.request(request)
puts response.read_body{
"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
Body
application/json
Response
200 - application/json
OK
The last time this provider was synchronized with the portal
Example:
"7 minutes 5 seconds ago"
UUID of this API provider in the portal's database
Example:
1
Name of this API Provider
Example:
"Tyk Dashboard"
Identifies if this API Provider is Up and ready for synchronization
Example:
"Up"
Type of API gateway used by this API Provider e.g. Tyk or AWS
Example:
"tyk-pro"
Show child attributes
Show child attributes
When this API Provider was updated the last time
Pattern:
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$Example:
"2023-06-23 19:13"
When this API Provider was created
Pattern:
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$Example:
"2023-06-23 19:13"
Was this page helpful?
⌘I