OrganisationsDeployments
Deployments API
Read the regions and endpoint hosts.
Both routes are on the API host and require a user token. They do not create infrastructure.
Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /api/endpoints | List regional endpoints |
| GET | /api/meta | Read platform metadata |
List endpoints
GET /api/endpoints returns the hosts a caller can use.
The example is abbreviated. Use the response returned by the route as the current endpoint list.
Request
curl -X GET "https://api.requestrocket.com/api/endpoints" \
-H "Authorization: u-your-token"import axios from "axios";
const response = await axios.request({
method: "GET",
url: "https://api.requestrocket.com/api/endpoints",
headers: {
"Authorization": "u-your-token",
}
});
console.log(response.status, response.data);import requests
response = requests.request(
"GET",
"https://api.requestrocket.com/api/endpoints",
headers={
"Authorization": "u-your-token",
}
)
print(response.status_code, response.json())package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
var payload io.Reader
req, _ := http.NewRequest("GET", "https://api.requestrocket.com/api/endpoints", payload)
req.Header.Set("Authorization", "u-your-token")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(resp.StatusCode, string(body))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.requestrocket.com/api/endpoints"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.header("Authorization", "u-your-token")
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}Responses
[
{
"name": "US East (Ohio)",
"code": "us-east-2",
"baseURL": "https://us-east-2.requestrocket.com"
},
{
"name": "Asia Pacific (Sydney)",
"code": "ap-southeast-2",
"baseURL": "https://ap-southeast-2.requestrocket.com"
},
{
"name": "Europe (London)",
"code": "eu-west-2",
"baseURL": "https://eu-west-2.requestrocket.com"
},
{
"name": "Asia Pacific (Mumbai)",
"code": "ap-south-1",
"baseURL": "https://ap-south-1.requestrocket.com"
}
]{
"Message": "User is not authorized to access this resource with an explicit deny in an identity-based policy"
}{
"message": "method / endpoint not supported"
}Query parameters
None.
Response
| Attribute | Type | Description |
|---|---|---|
name | string | Display name of the region. |
code | string | Region code, such as us-east-2. |
baseURL | string | HTTPS host for that region. |
The production endpoint handler currently publishes:
| Region | Code | Base URL |
|---|---|---|
| US East (Ohio) | us-east-2 | https://us-east-2.requestrocket.com |
| Asia Pacific (Sydney) | ap-southeast-2 | https://ap-southeast-2.requestrocket.com |
| Europe (London) | eu-west-2 | https://eu-west-2.requestrocket.com |
| Asia Pacific (Mumbai) | ap-south-1 | https://ap-south-1.requestrocket.com |
| Asia Pacific (Taiwan) | ap-east-2 | https://ap-east-2.requestrocket.com |
| South America (São Paulo) | sa-east-1 | https://prod-sa-east-1.requestrocket.com |
| Africa (Cape Town) | af-south-1 | https://prod-af-south-1.requestrocket.com |
| Middle East (UAE) | me-central-1 | https://me-central-1.requestrocket.com |
| Asia Pacific (Singapore) | ap-southeast-1 | https://ap-southeast-1.requestrocket.com |
| US West (N. California) | us-west-1 | https://us-west-1.requestrocket.com |
| Canada West (Calgary) | ca-west-1 | https://ca-west-1.requestrocket.com |
| Europe (Spain) | eu-south-2 | https://eu-south-2.requestrocket.com |
| Asia Pacific (Tokyo) | ap-northeast-1 | https://ap-northeast-1.requestrocket.com |
Read metadata
GET /api/meta returns platform metadata.
Request
curl -X GET "https://api.requestrocket.com/api/meta" \
-H "Authorization: u-your-token"import axios from "axios";
const response = await axios.request({
method: "GET",
url: "https://api.requestrocket.com/api/meta",
headers: {
"Authorization": "u-your-token",
}
});
console.log(response.status, response.data);import requests
response = requests.request(
"GET",
"https://api.requestrocket.com/api/meta",
headers={
"Authorization": "u-your-token",
}
)
print(response.status_code, response.json())package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
var payload io.Reader
req, _ := http.NewRequest("GET", "https://api.requestrocket.com/api/meta", payload)
req.Header.Set("Authorization", "u-your-token")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(resp.StatusCode, string(body))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.requestrocket.com/api/meta"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.header("Authorization", "u-your-token")
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}Responses
{
"callbackURL": "https://app.requestrocket.com/webhooks/oauth2",
"environment": "prod",
"apiVersion": "1.1.0",
"documentationUrl": "https://docs.requestrocket.com"
}{
"Message": "User is not authorized to access this resource with an explicit deny in an identity-based policy"
}{
"message": "method / endpoint not supported"
}Query parameters
None.
Response
| Attribute | Type | Description |
|---|---|---|
callbackURL | string | Redirect URL to register with an OAuth authorisation server. |
environment | string | Platform label for this API host. |
apiVersion | string | Core API version. |
documentationUrl | string | Documentation site. |
Shared status codes, the 5.5 MB cap, and plan rate limits are on Platform limits.