# API objects

> Every object the Guv API sends or receives.

Every schema in the API contract, alphabetically. Operation pages link here for field-level detail.

| Object | Description |
| --- | --- |
| [ActivityItemList](/docs/api/objects/activity-item-list/) | A page of ActivityItem objects. |
| [ActivityItem](/docs/api/objects/activity-item/) | One line of the activity feed, already phrased for people. |
| [Actor](/docs/api/objects/actor/) | Who did something. |
| [AgentTokenBudget](/docs/api/objects/agent-token-budget/) | What the agent may do without asking. |
| [AgentTokenCreate](/docs/api/objects/agent-token-create/) |  |
| [AgentTokenCreated](/docs/api/objects/agent-token-created/) |  |
| [AgentTokenList](/docs/api/objects/agent-token-list/) | A page of AgentToken objects. |
| [AgentTokenUpdate](/docs/api/objects/agent-token-update/) |  |
| [AgentToken](/docs/api/objects/agent-token/) |  |
| [AlertRuleCreate](/docs/api/objects/alert-rule-create/) |  |
| [AlertRuleList](/docs/api/objects/alert-rule-list/) | A page of AlertRule objects. |
| [AlertRule](/docs/api/objects/alert-rule/) |  |
| [ApprovalChannel](/docs/api/objects/approval-channel/) |  |
| [ApprovalCreate](/docs/api/objects/approval-create/) | Ask in advance for approval of a specific request (the request_approval MCP tool). |
| [ApprovalDecision](/docs/api/objects/approval-decision/) |  |
| [ApprovalDeny](/docs/api/objects/approval-deny/) |  |
| [ApprovalList](/docs/api/objects/approval-list/) | A page of Approval objects. |
| [ApprovalRef](/docs/api/objects/approval-ref/) |  |
| [ApprovalStatus](/docs/api/objects/approval-status/) |  |
| [Approval](/docs/api/objects/approval/) | A request for a human to allow an action. |
| [AuditEventList](/docs/api/objects/audit-event-list/) | A page of AuditEvent objects. |
| [AuditEvent](/docs/api/objects/audit-event/) | Append-only, hash-chained audit record. |
| [BackupCreate](/docs/api/objects/backup-create/) |  |
| [BillingPortalSession](/docs/api/objects/billing-portal-session/) |  |
| [Billing](/docs/api/objects/billing/) |  |
| [BuildSettings](/docs/api/objects/build-settings/) |  |
| [Build](/docs/api/objects/build/) |  |
| [CanvasGroup](/docs/api/objects/canvas-group/) | Named visual group of canvas nodes. |
| [CanvasLayout](/docs/api/objects/canvas-layout/) | Presentation-only dashboard canvas layout. |
| [CanvasNodePosition](/docs/api/objects/canvas-node-position/) | Position and display state of one canvas node. |
| [CanvasViewport](/docs/api/objects/canvas-viewport/) | Saved canvas viewport. |
| [CanvasWarning](/docs/api/objects/canvas-warning/) | Non-blocking canvas reference warning. |
| [ChangeList](/docs/api/objects/change-list/) | A page of Change objects. |
| [Change](/docs/api/objects/change/) | An AI ops (or human) change to the platform, with its policy decision and review. |
| [CheckState](/docs/api/objects/check-state/) |  |
| [Classification](/docs/api/objects/classification/) | Data classification. |
| [CostDelta](/docs/api/objects/cost-delta/) | Estimated monthly cost at current usage. |
| [CronSettings](/docs/api/objects/cron-settings/) |  |
| [DatabaseBackupList](/docs/api/objects/database-backup-list/) | A page of DatabaseBackup objects. |
| [DatabaseBackup](/docs/api/objects/database-backup/) |  |
| [DatabaseBranchCreate](/docs/api/objects/database-branch-create/) |  |
| [DatabaseBranchList](/docs/api/objects/database-branch-list/) | A page of DatabaseBranch objects. |
| [DatabaseBranch](/docs/api/objects/database-branch/) |  |
| [DatabaseConnection](/docs/api/objects/database-connection/) | Credentials. |
| [DatabaseCreate](/docs/api/objects/database-create/) |  |
| [DatabaseEngine](/docs/api/objects/database-engine/) |  |
| [DatabaseList](/docs/api/objects/database-list/) | A page of Database objects. |
| [DatabasePlanId](/docs/api/objects/database-plan-id/) |  |
| [DatabasePlanList](/docs/api/objects/database-plan-list/) | A page of DatabasePlan objects. |
| [DatabasePlan](/docs/api/objects/database-plan/) |  |
| [DatabaseRestoreRequest](/docs/api/objects/database-restore-request/) |  |
| [DatabaseStatus](/docs/api/objects/database-status/) |  |
| [DatabaseUpdate](/docs/api/objects/database-update/) |  |
| [Database](/docs/api/objects/database/) |  |
| [DeployExplanation](/docs/api/objects/deploy-explanation/) | What went wrong and how to fix it. |
| [DeploymentCreate](/docs/api/objects/deployment-create/) | Deploy a service. |
| [DeploymentList](/docs/api/objects/deployment-list/) | A page of Deployment objects. |
| [DeploymentRollback](/docs/api/objects/deployment-rollback/) |  |
| [DeploymentStatus](/docs/api/objects/deployment-status/) |  |
| [Deployment](/docs/api/objects/deployment/) | Immutable record of one rollout. |
| [DevLoginRequest](/docs/api/objects/dev-login-request/) |  |
| [DeviceCodeRequest](/docs/api/objects/device-code-request/) |  |
| [DeviceCodeResponse](/docs/api/objects/device-code-response/) | RFC 8628 device authorisation response. |
| [DeviceDecisionRequest](/docs/api/objects/device-decision-request/) |  |
| [DeviceLookup](/docs/api/objects/device-lookup/) |  |
| [DiffEntry](/docs/api/objects/diff-entry/) |  |
| [DnsRecord](/docs/api/objects/dns-record/) |  |
| [DomainCreate](/docs/api/objects/domain-create/) |  |
| [DomainList](/docs/api/objects/domain-list/) | A page of Domain objects. |
| [DomainStatus](/docs/api/objects/domain-status/) | pending (waiting for DNS) → verified (routing and ownership records found) → cert_issued → active (serving). |
| [DomainUpdate](/docs/api/objects/domain-update/) |  |
| [Domain](/docs/api/objects/domain/) |  |
| [EmailVerificationRequest](/docs/api/objects/email-verification-request/) |  |
| [EmailVerificationStarted](/docs/api/objects/email-verification-started/) |  |
| [EnvironmentCreate](/docs/api/objects/environment-create/) |  |
| [EnvironmentList](/docs/api/objects/environment-list/) | A page of Environment objects. |
| [EnvironmentProtection](/docs/api/objects/environment-protection/) |  |
| [EnvironmentUpdate](/docs/api/objects/environment-update/) |  |
| [Environment](/docs/api/objects/environment/) |  |
| [FailureCategory](/docs/api/objects/failure-category/) |  |
| [FieldError](/docs/api/objects/field-error/) |  |
| [FixAction](/docs/api/objects/fix-action/) | Something a person or agent can do to resolve a finding or failure. |
| [GitCommit](/docs/api/objects/git-commit/) |  |
| [GitHubConnectRequest](/docs/api/objects/git-hub-connect-request/) |  |
| [GitHubInstallUrl](/docs/api/objects/git-hub-install-url/) |  |
| [GitHubInstallationList](/docs/api/objects/git-hub-installation-list/) | A page of GitHubInstallation objects. |
| [GitHubInstallation](/docs/api/objects/git-hub-installation/) |  |
| [GitHubRepositoryList](/docs/api/objects/git-hub-repository-list/) | A page of GitHubRepository objects. |
| [GitHubRepository](/docs/api/objects/git-hub-repository/) |  |
| [GraphEdge](/docs/api/objects/graph-edge/) |  |
| [GraphLayoutUpdate](/docs/api/objects/graph-layout-update/) |  |
| [GraphNode](/docs/api/objects/graph-node/) |  |
| [Health](/docs/api/objects/health/) |  |
| [Healthcheck](/docs/api/objects/healthcheck/) |  |
| [IncidentCreate](/docs/api/objects/incident-create/) |  |
| [IncidentEventCreate](/docs/api/objects/incident-event-create/) |  |
| [IncidentEventList](/docs/api/objects/incident-event-list/) | A page of IncidentEvent objects. |
| [IncidentEvent](/docs/api/objects/incident-event/) |  |
| [IncidentList](/docs/api/objects/incident-list/) | A page of Incident objects. |
| [IncidentSeverity](/docs/api/objects/incident-severity/) |  |
| [IncidentStatus](/docs/api/objects/incident-status/) |  |
| [IncidentUpdate](/docs/api/objects/incident-update/) |  |
| [Incident](/docs/api/objects/incident/) |  |
| [InvitationAccept](/docs/api/objects/invitation-accept/) |  |
| [InviteAcceptRequest](/docs/api/objects/invite-accept-request/) |  |
| [InviteCreateRequest](/docs/api/objects/invite-create-request/) |  |
| [InviteCreated](/docs/api/objects/invite-created/) |  |
| [InviteList](/docs/api/objects/invite-list/) |  |
| [InvitePreview](/docs/api/objects/invite-preview/) |  |
| [Invite](/docs/api/objects/invite/) |  |
| [InvoiceList](/docs/api/objects/invoice-list/) | A page of Invoice objects. |
| [Invoice](/docs/api/objects/invoice/) |  |
| [KillSwitchDisengage](/docs/api/objects/kill-switch-disengage/) |  |
| [KillSwitchEngage](/docs/api/objects/kill-switch-engage/) |  |
| [KillSwitchStatus](/docs/api/objects/kill-switch-status/) |  |
| [LogLine](/docs/api/objects/log-line/) | One log line. |
| [LogQueryResult](/docs/api/objects/log-query-result/) |  |
| [LoginResponse](/docs/api/objects/login-response/) | Returned by every sign-in. |
| [ManifestApplyRequest](/docs/api/objects/manifest-apply-request/) |  |
| [ManifestExport](/docs/api/objects/manifest-export/) |  |
| [ManifestInput](/docs/api/objects/manifest-input/) |  |
| [ManifestIssue](/docs/api/objects/manifest-issue/) |  |
| [ManifestStatus](/docs/api/objects/manifest-status/) |  |
| [ManifestValidation](/docs/api/objects/manifest-validation/) |  |
| [MaskingRules](/docs/api/objects/masking-rules/) | table.column to a masking rule, applied to branches before they are attached. |
| [Me](/docs/api/objects/me/) | The calling principal. |
| [MemberInvite](/docs/api/objects/member-invite/) |  |
| [MemberList](/docs/api/objects/member-list/) | A page of Member objects. |
| [MemberUpdate](/docs/api/objects/member-update/) |  |
| [Member](/docs/api/objects/member/) |  |
| [MetricName](/docs/api/objects/metric-name/) |  |
| [MetricSeries](/docs/api/objects/metric-series/) |  |
| [MetricsResult](/docs/api/objects/metrics-result/) |  |
| [Money](/docs/api/objects/money/) | An amount in pounds sterling. |
| [OnCapAction](/docs/api/objects/on-cap-action/) | What happens at 100%. |
| [OnboardingStep](/docs/api/objects/onboarding-step/) |  |
| [OnboardingUpdate](/docs/api/objects/onboarding-update/) |  |
| [Onboarding](/docs/api/objects/onboarding/) |  |
| [OperationEvent](/docs/api/objects/operation-event/) | One event in an operation's stream. |
| [OperationList](/docs/api/objects/operation-list/) | A page of Operation objects. |
| [OperationStatus](/docs/api/objects/operation-status/) |  |
| [OperationStep](/docs/api/objects/operation-step/) |  |
| [Operation](/docs/api/objects/operation/) | A long-running unit of work. |
| [PasskeyAssertion](/docs/api/objects/passkey-assertion/) | A completed step-up assertion bound to a purpose and subject. |
| [PasskeyChallenge](/docs/api/objects/passkey-challenge/) |  |
| [PasskeyFinishRequest](/docs/api/objects/passkey-finish-request/) |  |
| [PasskeyList](/docs/api/objects/passkey-list/) | A page of Passkey objects. |
| [PasskeyLoginBeginRequest](/docs/api/objects/passkey-login-begin-request/) |  |
| [PasskeyRegisterBeginRequest](/docs/api/objects/passkey-register-begin-request/) | Signed in, adds a passkey. |
| [Passkey](/docs/api/objects/passkey/) |  |
| [PersonalAccessTokenCreate](/docs/api/objects/personal-access-token-create/) |  |
| [PersonalAccessTokenCreated](/docs/api/objects/personal-access-token-created/) |  |
| [PersonalAccessTokenList](/docs/api/objects/personal-access-token-list/) | A page of PersonalAccessToken objects. |
| [PersonalAccessToken](/docs/api/objects/personal-access-token/) |  |
| [PlanChangeRequest](/docs/api/objects/plan-change-request/) |  |
| [PlanChange](/docs/api/objects/plan-change/) |  |
| [PlanLayout](/docs/api/objects/plan-layout/) | Cost-free presentation layout section; never deploys. |
| [PlanWarning](/docs/api/objects/plan-warning/) |  |
| [Plan](/docs/api/objects/plan/) | The result of a dry run or guv plan. |
| [PolicyDecision](/docs/api/objects/policy-decision/) |  |
| [PolicyReason](/docs/api/objects/policy-reason/) |  |
| [Problem](/docs/api/objects/problem/) | RFC 9457 problem details with Guv extensions. |
| [ProjectCanvas](/docs/api/objects/project-canvas/) | Saved dashboard canvas layout and manifest drift status. |
| [ProjectCreate](/docs/api/objects/project-create/) |  |
| [ProjectGraph](/docs/api/objects/project-graph/) | The project canvas for one environment. |
| [ProjectList](/docs/api/objects/project-list/) | A page of Project objects. |
| [ProjectStatus](/docs/api/objects/project-status/) | Everything about a project in one call (the MCP project_status tool). |
| [ProjectUpdate](/docs/api/objects/project-update/) |  |
| [Project](/docs/api/objects/project/) |  |
| [RateCard](/docs/api/objects/rate-card/) |  |
| [Region](/docs/api/objects/region/) | Region. |
| [Replicas](/docs/api/objects/replicas/) |  |
| [RepoBinding](/docs/api/objects/repo-binding/) |  |
| [Residency](/docs/api/objects/residency/) | Where compute, volumes, backups and logs may live. |
| [ResourceRef](/docs/api/objects/resource-ref/) | A pointer to any Guv resource. |
| [Role](/docs/api/objects/role/) | Workspace role. |
| [SafetyAcknowledge](/docs/api/objects/safety-acknowledge/) |  |
| [SafetyBadgeSummary](/docs/api/objects/safety-badge-summary/) | Public, unauthenticated summary behind the "Secured on Guv" badge. |
| [SafetyCategory](/docs/api/objects/safety-category/) |  |
| [SafetyCheck](/docs/api/objects/safety-check/) |  |
| [SafetyGrade](/docs/api/objects/safety-grade/) |  |
| [SafetyReport](/docs/api/objects/safety-report/) |  |
| [ScaleOn](/docs/api/objects/scale-on/) |  |
| [Scope](/docs/api/objects/scope/) | A scope from the Guv scope registry (see the guvOAuth security scheme). |
| [SecretMetadataList](/docs/api/objects/secret-metadata-list/) | A page of SecretMetadata objects. |
| [SecretMetadata](/docs/api/objects/secret-metadata/) | Everything about a secret except its value, which can never be read back. |
| [SecretRotateRequest](/docs/api/objects/secret-rotate-request/) |  |
| [SecretSetRequest](/docs/api/objects/secret-set-request/) |  |
| [ServiceConfig](/docs/api/objects/service-config/) | Settings of a service. |
| [ServiceCreate](/docs/api/objects/service-create/) |  |
| [ServiceInstanceList](/docs/api/objects/service-instance-list/) | A page of ServiceInstance objects. |
| [ServiceInstanceUpdate](/docs/api/objects/service-instance-update/) |  |
| [ServiceInstance](/docs/api/objects/service-instance/) | A service as it runs in one environment (base settings merged with that environment's overrides). |
| [ServiceList](/docs/api/objects/service-list/) | A page of Service objects. |
| [ServiceResources](/docs/api/objects/service-resources/) | Limits. |
| [ServiceRestart](/docs/api/objects/service-restart/) |  |
| [ServiceSource](/docs/api/objects/service-source/) |  |
| [ServiceStatus](/docs/api/objects/service-status/) |  |
| [ServiceSummary](/docs/api/objects/service-summary/) |  |
| [Service](/docs/api/objects/service/) | A service defined once per project. |
| [SessionInfoList](/docs/api/objects/session-info-list/) | A page of SessionInfo objects. |
| [SessionInfo](/docs/api/objects/session-info/) |  |
| [SignupBeginRequest](/docs/api/objects/signup-begin-request/) |  |
| [SignupChallenge](/docs/api/objects/signup-challenge/) |  |
| [SignupConfig](/docs/api/objects/signup-config/) |  |
| [SignupPow](/docs/api/objects/signup-pow/) |  |
| [SignupStarted](/docs/api/objects/signup-started/) |  |
| [SourceUpload](/docs/api/objects/source-upload/) |  |
| [SpendBreakdownItem](/docs/api/objects/spend-breakdown-item/) |  |
| [SpendCapCreate](/docs/api/objects/spend-cap-create/) |  |
| [SpendCapList](/docs/api/objects/spend-cap-list/) | A page of SpendCap objects. |
| [SpendCapStatus](/docs/api/objects/spend-cap-status/) |  |
| [SpendCapUpdate](/docs/api/objects/spend-cap-update/) | Raising amount always needs a human (agents get approval_required). |
| [SpendCap](/docs/api/objects/spend-cap/) |  |
| [SpendSummary](/docs/api/objects/spend-summary/) |  |
| [StackDetectRequest](/docs/api/objects/stack-detect-request/) |  |
| [StackDetection](/docs/api/objects/stack-detection/) |  |
| [StepUpBeginRequest](/docs/api/objects/step-up-begin-request/) | Start a passkey assertion that proves presence for a sensitive action. |
| [TemplateDeployRequest](/docs/api/objects/template-deploy-request/) |  |
| [TemplateList](/docs/api/objects/template-list/) | A page of Template objects. |
| [Template](/docs/api/objects/template/) |  |
| [TokenRequest](/docs/api/objects/token-request/) | OAuth 2.0 token request (form or JSON). |
| [TokenResponse](/docs/api/objects/token-response/) |  |
| [UsageMetric](/docs/api/objects/usage-metric/) | Metered quantities. |
| [UsageReport](/docs/api/objects/usage-report/) |  |
| [UsageResourceTotal](/docs/api/objects/usage-resource-total/) | Actual usage total for one resource. |
| [UsageResource](/docs/api/objects/usage-resource/) | A billable usage resource. |
| [UsageRow](/docs/api/objects/usage-row/) |  |
| [UsageTimeseriesPoint](/docs/api/objects/usage-timeseries-point/) | Usage and cost for one bucket. |
| [UsageTimeseriesSeries](/docs/api/objects/usage-timeseries-series/) | One grouped usage series. |
| [UsageTimeseries](/docs/api/objects/usage-timeseries/) | Usage, costs and forecasts over aligned buckets. |
| [UserUpdate](/docs/api/objects/user-update/) |  |
| [User](/docs/api/objects/user/) |  |
| [VariableInput](/docs/api/objects/variable-input/) |  |
| [VariableList](/docs/api/objects/variable-list/) | A page of Variable objects. |
| [VariableSetRequest](/docs/api/objects/variable-set-request/) |  |
| [VariableSetResult](/docs/api/objects/variable-set-result/) |  |
| [Variable](/docs/api/objects/variable/) | A plain variable or reference. |
| [VolumeCreate](/docs/api/objects/volume-create/) |  |
| [VolumeList](/docs/api/objects/volume-list/) | A page of Volume objects. |
| [VolumeMount](/docs/api/objects/volume-mount/) |  |
| [VolumeStatus](/docs/api/objects/volume-status/) |  |
| [VolumeUpdate](/docs/api/objects/volume-update/) |  |
| [Volume](/docs/api/objects/volume/) |  |
| [WaitlistConfirmRequest](/docs/api/objects/waitlist-confirm-request/) |  |
| [WaitlistConfirmed](/docs/api/objects/waitlist-confirmed/) |  |
| [WaitlistEntryList](/docs/api/objects/waitlist-entry-list/) |  |
| [WaitlistEntry](/docs/api/objects/waitlist-entry/) |  |
| [WaitlistJoinAccepted](/docs/api/objects/waitlist-join-accepted/) |  |
| [WaitlistJoinRequest](/docs/api/objects/waitlist-join-request/) |  |
| [WebAuthnCreationOptions](/docs/api/objects/web-authn-creation-options/) | PublicKeyCredentialCreationOptionsJSON from WebAuthn Level 3. |
| [WebAuthnCredential](/docs/api/objects/web-authn-credential/) | RegistrationResponseJSON or AuthenticationResponseJSON from PublicKeyCredential.toJSON(). |
| [WebAuthnRequestOptions](/docs/api/objects/web-authn-request-options/) | PublicKeyCredentialRequestOptionsJSON from WebAuthn Level 3. |
| [WebhookCreate](/docs/api/objects/webhook-create/) |  |
| [WebhookCreated](/docs/api/objects/webhook-created/) |  |
| [WebhookDeliveryList](/docs/api/objects/webhook-delivery-list/) | A page of WebhookDelivery objects. |
| [WebhookDelivery](/docs/api/objects/webhook-delivery/) |  |
| [WebhookEventType](/docs/api/objects/webhook-event-type/) |  |
| [WebhookEvent](/docs/api/objects/webhook-event/) | Body of every outbound webhook. |
| [WebhookList](/docs/api/objects/webhook-list/) | A page of Webhook objects. |
| [WebhookSecret](/docs/api/objects/webhook-secret/) |  |
| [WebhookUpdate](/docs/api/objects/webhook-update/) |  |
| [Webhook](/docs/api/objects/webhook/) |  |
| [WorkspaceCreate](/docs/api/objects/workspace-create/) |  |
| [WorkspaceList](/docs/api/objects/workspace-list/) | A page of Workspace objects. |
| [WorkspaceMembership](/docs/api/objects/workspace-membership/) |  |
| [WorkspacePlan](/docs/api/objects/workspace-plan/) |  |
| [WorkspaceUpdate](/docs/api/objects/workspace-update/) |  |
| [Workspace](/docs/api/objects/workspace/) |  |