Apollo Deploy Platform Service SDK

Platform service — identity, access management, API keys, and organization management.

Generated by Tesseract. Generated source files should not be edited manually.

Installation

npm install @apollo-deploy/platform-sdk-internal

Quick start

import { createApolloPlatformClient } from '@apollo-deploy/platform-sdk-internal';

const client = createApolloPlatformClient({
  baseUrl: 'https://api.platform.apollodeploy.local',
  timeoutMs: 15_000,
});

// Domain clients are available directly on the client.
const api = client.auth;

Configuration and reliability

The generated transport supports:

• Bounded request timeouts and AbortSignal cancellation
• Exponential-backoff retries for transient failures
• Retry-After handling for rate limits
• Per-request headers, timeout, and retry overrides
• Structured SDKError values with HTTP status, error code, and request ID
• Request/response hooks and transport plugins for logging or telemetry

const client = createApolloPlatformClient({
  timeoutMs: 30_000,
  defaultHeaders: { 'X-Application': 'my-service' },
  retries: {
    attempts: 3,
    backoffMs: 400,
    jitter: true,
  },
});

Mutating requests are retried only when the request is considered idempotent, carries an idempotency key, or the retry policy explicitly allows it.

Documentation

• Documentation index
• Generated types

| Domain | Description | |---|---| | AuthAPI | auth operations | | OAuthAPI | OAuth 2.0 authorization server endpoints | | DeviceAuthorizationAPI | OAuth 2.0 device authorization grant flow | | PasskeysAPI | passkeys operations | | MfaAPI | mfa operations | | SessionsAPI | sessions operations | | OrganizationApiKeysAPI | Organization-scoped API key management | | InternalIamAPI | internalIam operations | | AuditLogsAPI | App-scoped audit log access, summaries, exports | | AppSettingsAPI | appSettings operations | | AppsAPI | apps operations | | OrganizationsAPI | organizations operations | | TeamsAPI | teams operations | | BillingAPI | Org-level billing — subscriptions, entitlements, checkout, invoices, and customer portal | | UploadsAPI | uploads operations | | AdminUsersAPI | adminUsers operations | | WaitlistAPI | waitlist operations |

Error handling

import { SDKError } from '@apollo-deploy/platform-sdk-internal';

try {
  // await client.someDomain.someOperation();
} catch (error) {
  if (error instanceof SDKError) {
    console.error(error.status, error.code, error.requestId);
  }
  throw error;
}

License

MIT