API fundamentals
Reference to the public foundations of the platformAPI, which covers endpoint pathways, OAuth token authentication, organization purpose, paging, and errors.
The web console usesGraphQL,MCPexposes specially built tools, prb provides terminal commands,n8packs common operations for visual workflows, and the Device AgentAPIaccepts entry and posture reports from endpoint agents.
Endpoints
Posts Tagged ‘Endpoints’For the platform origin, such as https://probo.example.com, the routes are mounted below /api:
- Console GraphQL:
/api/console/v1/graphql - MCP:
/api/mcp/v1 - Cookie banner:
/api/cookie-banner/v1 - Device agent:
/api/agent/v1
Some services, including OAuth Discovery, use the ___ZBT_I18N_RUNTIME_BLOCK_174__ routes on the same source.
Authentication
Section entitled “Authentication”Create a scalable access token from your account menu. OAuth tokens for clients using static carrier authentication. Select only the necessary resource domains, store the token in a secret manager and spin it after suspicious disclosure.
Interactive clients can use supported OAuth authorization streams instead. SSO sessions and SCIM tokens serve different purposes and should not be replaced with an OAuth access token.
Organization scope and identifiers
Section entitled “Organization scope and identifiers”Provide the required organization identifier for operation and do not assume that a logged-in user can access each organization. the platform uses globally unique IDs that encode a type of entity; customers must still treat the IDs as opacous strings.
Pagination
Posts Tagged ‘Pagination’List operations typically use cursor pageing. Request a limited page, process its edges, and proceed with the final cursor returned while another page is available.
Errors
Posts Tagged ‘Errors’PublicAPIs distinguish between unauthenticated, prohibited, undetected, invalid and conflicting conditions. Unexpected failures return a generic internal error; implementation details are not intentionally exposed.