Skip to main content
Use the services and invoices endpoints to view your Orbitel Shield account services, their status and billing details, and the invoices associated with them. All monetary values are returned in cents. Timestamps are ISO8601 UTC. IDs are 26-character strings.
Base URL: https://portal.orbitelshield.com/api/v1/public
Authentication: Bearer token in the Authorization header
Rate limit: 120 requests per minute, including at most 30 writes

​
List services

Retrieve a list of services for your account, ordered newest first. Each entry includes the plan, limits, status, and next due date.

​
Endpoint

​
Permissions

Requires the services:read scope.

​
Query parameters

​
Example request

​
Get a service

Retrieve a single service by ID, including the last 12 invoices.

​
Endpoint

​
Permissions

Requires the services:read scope.

​
Path parameters

​
Example request

​
List invoices

Retrieve a list of invoices for your account, including totals in cents and an overdue flag.

​
Endpoint

​
Permissions

Requires the invoices:read scope. This scope is read only. Paying invoices, applying credit, and changing billing details must be done from the panel.

​
Query parameters

​
Example request

​
Get an invoice

Retrieve a single invoice by ID, including its lines, tax breakdown, and payments.

​
Endpoint

​
Permissions

Requires the invoices:read scope.

​
Path parameters

​
Example request

Protection

Read protected services, prefixes, tunnels, traffic, and attacks.

Protection changes

Change prefixes and tunnels or push the current network configuration.

Tickets

Create and manage support tickets.

Webhook signatures

Verify signed attack alert deliveries.

​
Error handling

For common error responses, authentication issues, and rate-limiting behavior, see the errors page. For a general overview of the Orbitel Shield API, including authentication and request conventions, see the API overview.