API objects
Every schema in the API contract, alphabetically. Operation pages link here for field-level detail.
| Object | Description |
|---|---|
| ActivityItemList | A page of ActivityItem objects. |
| ActivityItem | One line of the activity feed, already phrased for people. |
| Actor | Who did something. |
| AgentTokenBudget | What the agent may do without asking. |
| AgentTokenCreate | |
| AgentTokenCreated | |
| AgentTokenList | A page of AgentToken objects. |
| AgentTokenUpdate | |
| AgentToken | |
| AlertRuleCreate | |
| AlertRuleList | A page of AlertRule objects. |
| AlertRule | |
| ApprovalChannel | |
| ApprovalCreate | Ask in advance for approval of a specific request (the request_approval MCP tool). |
| ApprovalDecision | |
| ApprovalDeny | |
| ApprovalList | A page of Approval objects. |
| ApprovalRef | |
| ApprovalStatus | |
| Approval | A request for a human to allow an action. |
| AuditEventList | A page of AuditEvent objects. |
| AuditEvent | Append-only, hash-chained audit record. |
| BackupCreate | |
| BillingPortalSession | |
| Billing | |
| BuildSettings | |
| Build | |
| CanvasGroup | Named visual group of canvas nodes. |
| CanvasLayout | Presentation-only dashboard canvas layout. |
| CanvasNodePosition | Position and display state of one canvas node. |
| CanvasViewport | Saved canvas viewport. |
| CanvasWarning | Non-blocking canvas reference warning. |
| ChangeList | A page of Change objects. |
| Change | An AI ops (or human) change to the platform, with its policy decision and review. |
| CheckState | |
| Classification | Data classification. |
| CostDelta | Estimated monthly cost at current usage. |
| CronSettings | |
| DatabaseBackupList | A page of DatabaseBackup objects. |
| DatabaseBackup | |
| DatabaseBranchCreate | |
| DatabaseBranchList | A page of DatabaseBranch objects. |
| DatabaseBranch | |
| DatabaseConnection | Credentials. |
| DatabaseCreate | |
| DatabaseEngine | |
| DatabaseList | A page of Database objects. |
| DatabasePlanId | |
| DatabasePlanList | A page of DatabasePlan objects. |
| DatabasePlan | |
| DatabaseRestoreRequest | |
| DatabaseStatus | |
| DatabaseUpdate | |
| Database | |
| DeployExplanation | What went wrong and how to fix it. |
| DeploymentCreate | Deploy a service. |
| DeploymentList | A page of Deployment objects. |
| DeploymentRollback | |
| DeploymentStatus | |
| Deployment | Immutable record of one rollout. |
| DevLoginRequest | |
| DeviceCodeRequest | |
| DeviceCodeResponse | RFC 8628 device authorisation response. |
| DeviceDecisionRequest | |
| DeviceLookup | |
| DiffEntry | |
| DnsRecord | |
| DomainCreate | |
| DomainList | A page of Domain objects. |
| DomainStatus | pending (waiting for DNS) → verified (routing and ownership records found) → cert_issued → active (serving). |
| DomainUpdate | |
| Domain | |
| EmailVerificationRequest | |
| EmailVerificationStarted | |
| EnvironmentCreate | |
| EnvironmentList | A page of Environment objects. |
| EnvironmentProtection | |
| EnvironmentUpdate | |
| Environment | |
| FailureCategory | |
| FieldError | |
| FixAction | Something a person or agent can do to resolve a finding or failure. |
| GitCommit | |
| GitHubConnectRequest | |
| GitHubInstallUrl | |
| GitHubInstallationList | A page of GitHubInstallation objects. |
| GitHubInstallation | |
| GitHubRepositoryList | A page of GitHubRepository objects. |
| GitHubRepository | |
| GraphEdge | |
| GraphLayoutUpdate | |
| GraphNode | |
| Health | |
| Healthcheck | |
| IncidentCreate | |
| IncidentEventCreate | |
| IncidentEventList | A page of IncidentEvent objects. |
| IncidentEvent | |
| IncidentList | A page of Incident objects. |
| IncidentSeverity | |
| IncidentStatus | |
| IncidentUpdate | |
| Incident | |
| InvitationAccept | |
| InviteAcceptRequest | |
| InviteCreateRequest | |
| InviteCreated | |
| InviteList | |
| InvitePreview | |
| Invite | |
| InvoiceList | A page of Invoice objects. |
| Invoice | |
| KillSwitchDisengage | |
| KillSwitchEngage | |
| KillSwitchStatus | |
| LogLine | One log line. |
| LogQueryResult | |
| LoginResponse | Returned by every sign-in. |
| ManifestApplyRequest | |
| ManifestExport | |
| ManifestInput | |
| ManifestIssue | |
| ManifestStatus | |
| ManifestValidation | |
| MaskingRules | table.column to a masking rule, applied to branches before they are attached. |
| Me | The calling principal. |
| MemberInvite | |
| MemberList | A page of Member objects. |
| MemberUpdate | |
| Member | |
| MetricName | |
| MetricSeries | |
| MetricsResult | |
| Money | An amount in pounds sterling. |
| OnCapAction | What happens at 100%. |
| OnboardingStep | |
| OnboardingUpdate | |
| Onboarding | |
| OperationEvent | One event in an operation’s stream. |
| OperationList | A page of Operation objects. |
| OperationStatus | |
| OperationStep | |
| Operation | A long-running unit of work. |
| PasskeyAssertion | A completed step-up assertion bound to a purpose and subject. |
| PasskeyChallenge | |
| PasskeyFinishRequest | |
| PasskeyList | A page of Passkey objects. |
| PasskeyLoginBeginRequest | |
| PasskeyRegisterBeginRequest | Signed in, adds a passkey. |
| Passkey | |
| PersonalAccessTokenCreate | |
| PersonalAccessTokenCreated | |
| PersonalAccessTokenList | A page of PersonalAccessToken objects. |
| PersonalAccessToken | |
| PlanChangeRequest | |
| PlanChange | |
| PlanLayout | Cost-free presentation layout section; never deploys. |
| PlanWarning | |
| Plan | The result of a dry run or guv plan. |
| PolicyDecision | |
| PolicyReason | |
| Problem | RFC 9457 problem details with Guv extensions. |
| ProjectCanvas | Saved dashboard canvas layout and manifest drift status. |
| ProjectCreate | |
| ProjectGraph | The project canvas for one environment. |
| ProjectList | A page of Project objects. |
| ProjectStatus | Everything about a project in one call (the MCP project_status tool). |
| ProjectUpdate | |
| Project | |
| RateCard | |
| Region | Region. |
| Replicas | |
| RepoBinding | |
| Residency | Where compute, volumes, backups and logs may live. |
| ResourceRef | A pointer to any Guv resource. |
| Role | Workspace role. |
| SafetyAcknowledge | |
| SafetyBadgeSummary | Public, unauthenticated summary behind the “Secured on Guv” badge. |
| SafetyCategory | |
| SafetyCheck | |
| SafetyGrade | |
| SafetyReport | |
| ScaleOn | |
| Scope | A scope from the Guv scope registry (see the guvOAuth security scheme). |
| SecretMetadataList | A page of SecretMetadata objects. |
| SecretMetadata | Everything about a secret except its value, which can never be read back. |
| SecretRotateRequest | |
| SecretSetRequest | |
| ServiceConfig | Settings of a service. |
| ServiceCreate | |
| ServiceInstanceList | A page of ServiceInstance objects. |
| ServiceInstanceUpdate | |
| ServiceInstance | A service as it runs in one environment (base settings merged with that environment’s overrides). |
| ServiceList | A page of Service objects. |
| ServiceResources | Limits. |
| ServiceRestart | |
| ServiceSource | |
| ServiceStatus | |
| ServiceSummary | |
| Service | A service defined once per project. |
| SessionInfoList | A page of SessionInfo objects. |
| SessionInfo | |
| SignupBeginRequest | |
| SignupChallenge | |
| SignupConfig | |
| SignupPow | |
| SignupStarted | |
| SourceUpload | |
| SpendBreakdownItem | |
| SpendCapCreate | |
| SpendCapList | A page of SpendCap objects. |
| SpendCapStatus | |
| SpendCapUpdate | Raising amount always needs a human (agents get approval_required). |
| SpendCap | |
| SpendSummary | |
| StackDetectRequest | |
| StackDetection | |
| StepUpBeginRequest | Start a passkey assertion that proves presence for a sensitive action. |
| TemplateDeployRequest | |
| TemplateList | A page of Template objects. |
| Template | |
| TokenRequest | OAuth 2.0 token request (form or JSON). |
| TokenResponse | |
| UsageMetric | Metered quantities. |
| UsageReport | |
| UsageResourceTotal | Actual usage total for one resource. |
| UsageResource | A billable usage resource. |
| UsageRow | |
| UsageTimeseriesPoint | Usage and cost for one bucket. |
| UsageTimeseriesSeries | One grouped usage series. |
| UsageTimeseries | Usage, costs and forecasts over aligned buckets. |
| UserUpdate | |
| User | |
| VariableInput | |
| VariableList | A page of Variable objects. |
| VariableSetRequest | |
| VariableSetResult | |
| Variable | A plain variable or reference. |
| VolumeCreate | |
| VolumeList | A page of Volume objects. |
| VolumeMount | |
| VolumeStatus | |
| VolumeUpdate | |
| Volume | |
| WaitlistConfirmRequest | |
| WaitlistConfirmed | |
| WaitlistEntryList | |
| WaitlistEntry | |
| WaitlistJoinAccepted | |
| WaitlistJoinRequest | |
| WebAuthnCreationOptions | PublicKeyCredentialCreationOptionsJSON from WebAuthn Level 3. |
| WebAuthnCredential | RegistrationResponseJSON or AuthenticationResponseJSON from PublicKeyCredential.toJSON(). |
| WebAuthnRequestOptions | PublicKeyCredentialRequestOptionsJSON from WebAuthn Level 3. |
| WebhookCreate | |
| WebhookCreated | |
| WebhookDeliveryList | A page of WebhookDelivery objects. |
| WebhookDelivery | |
| WebhookEventType | |
| WebhookEvent | Body of every outbound webhook. |
| WebhookList | A page of Webhook objects. |
| WebhookSecret | |
| WebhookUpdate | |
| Webhook | |
| WorkspaceCreate | |
| WorkspaceList | A page of Workspace objects. |
| WorkspaceMembership | |
| WorkspacePlan | |
| WorkspaceUpdate | |
| Workspace |