curl --request POST \
--url https://api.turnkey.com/public/v1/query/get_ip_allowlist \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "X-Stamp: <string> (see Authorizations)" \
--data '{
"organizationId": "<string>",
"publicKey": "<string>"
}'
import { Turnkey } from "@turnkey/sdk-server";
const turnkeyClient = new Turnkey({
apiBaseUrl: "https://api.turnkey.com",
apiPublicKey: process.env.API_PUBLIC_KEY!,
apiPrivateKey: process.env.API_PRIVATE_KEY!,
defaultOrganizationId: process.env.ORGANIZATION_ID!,
});
const response = await turnkeyClient.apiClient().getIpAllowlist({
organizationId: "<string> (Unique identifier for a given Organization.)",
publicKey: "<string> (If provided, return only the allowlist for this specific API key.)"
});
{
"allowlist": {
"organizationId": "<string>",
"rules": [
{
"cidr": "<string>",
"label": "<string>",
"createdAt": "<string>"
}
],
"publicKey": "<string>",
"enabled": "<boolean>",
"onEvaluationError": "<string>"
}
}
Queries
Get IP Allowlist
Get IP allowlist and rules for an organization.
curl --request POST \
--url https://api.turnkey.com/public/v1/query/get_ip_allowlist \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "X-Stamp: <string> (see Authorizations)" \
--data '{
"organizationId": "<string>",
"publicKey": "<string>"
}'
import { Turnkey } from "@turnkey/sdk-server";
const turnkeyClient = new Turnkey({
apiBaseUrl: "https://api.turnkey.com",
apiPublicKey: process.env.API_PUBLIC_KEY!,
apiPrivateKey: process.env.API_PRIVATE_KEY!,
defaultOrganizationId: process.env.ORGANIZATION_ID!,
});
const response = await turnkeyClient.apiClient().getIpAllowlist({
organizationId: "<string> (Unique identifier for a given Organization.)",
publicKey: "<string> (If provided, return only the allowlist for this specific API key.)"
});
{
"allowlist": {
"organizationId": "<string>",
"rules": [
{
"cidr": "<string>",
"label": "<string>",
"createdAt": "<string>"
}
],
"publicKey": "<string>",
"enabled": "<boolean>",
"onEvaluationError": "<string>"
}
}
A successful response returns the following fields:
Was this page helpful?