GraphQL APIGraphQL API

Object

Most of the types you define in a GraphQL schema are object types. An object type contains a collection of fields, each of which has its own type.
Metadata for a Ansible resource.
ApiKey represents a user-generated API key.
ApiKeyOIDCSettings represents the OIDC settings for an API key.
This type represents one aspect data point
A collection of data points of some aspect
Percentile calculated for the returned data points.
Summary returned together with data points. Contains metadata generated from the data points.
Total sum of all data points
AuditTrailWebhook represents audit trail webhook configuration for the account.
AutoattachmentTarget is a stack or module that is autoattached to an entity that supports autoattachment.
AutoattachmentTargets is the list of autoattached stacks and modules.
AwsIntegration is an integration with AWS that you can attach to your stack
AwsIntegrationStackAttachment is the stack attachment viewed from the integration.
AzureIntegration represents an integration with an Azure AD tenant.
AzureIntegrationStackAttachment is the stack attachment viewed from the integration.
BillingAddon represents an addon that can be bought along with the plan.
BillingInfo represents account billing details stored in Stripe
BillingPlan represents a tier that can be bought.
BitbucketCloudIntegration shows Bitbucket Cloud integration details.
BitbucketDatacenterIntegration shows Bitbucket Datacenter integration details.
Metadata for a CloudFormation output.
Metadata for a CloudFormation resource.
Commit represents a GitHub commit.
ConfigElement is a stack runtime configuration element: environment variable or file mount.
ContextStackAttachment is the stack attachment viewed from the Context.
Delta is the number of resources affected by a Run in various ways.
DriftDetectionIntegration describes a Stack's drift detection configuration.
EffectiveTerragruntVersionResult represents the effective Terragrunt and Terraform versions to be used in a stack.
A Terraform managed entity change description.
A Terraform managed entity change description.
ExternalIdForStackResult contains information needed for creating AWS AssumeRole policies for an integration stack attachment.
The result of evaluating a feature flag.
GitHubAppManifest represents the data needed by the GitHub app creation form.
GithubEnterpriseIntegration shows GitHub Enterprise integration details.
GithubEnterpriseIntegrationInstallation represents a single GitHub Enterprise custom app installation.
GithubIntegration shows build-in GitHub integration details.
GitlabIntegration shows Gitlab integration details.
Hooks represents a collection of hooks extending the standard run lifecycle.
Metadata for a Kubernetes resource.
Metadata for a Kubernetes infra root.
LogMessage represents a single log line.
LogsResponse is a response to a query for a batch of logs.
Managed infrastructure entity
Managed infrastructure entity V2
This represent a managed state version
ManagedStateVersionConnection represents a single worker pool in a page of results.
Module is a versioned and tested reusable collection of resources
ModuleConnection represents a single module in a page of results.
ModuleInput represents a single module input variable in ModuleMetadata.
ModuleMetadata represents a root module or a submodule within the module repository.
ModuleOutput represents a single module output in ModuleMetadata.
ModuleProviderDependency represents a single module's provider dependency.
ModuleRepositoryMetadata represents the entire module repository metadata.
ModuleResource represents a single resource managed by a module.
A NamedWebhooksIntegration is a webhooks integration attached to a space with a name that can be referenced via notification policies. Each space can have one or more integration, allowing notification policies to route notifications to different webhook endpoints.
A newly created version of a managed Terraform provider.
Notification represents a single notification.
NotificationConnection represents a single notification in a page of results.
OAuthRedirect is a response to an OAuth redirect query.
OIDCSettings represent account's OIDC settings
The outcome of a collection of plan policies for a Run.
Policy is a rule or collection of rules that allow injecting custom logic into Spacelift's decision points.
PolicyConnection represents a single policy in a page of results.
PolicyEvaluationRecord is a record of policy evaluation. It contains a key, which can be separately used to retrieve the associated PolicyEvaluationSample.
PolicyEvaluationSample represents a single instance of policy evaluation.
PolicyRuntimeDetails represents the versions of the policy runtime used
PolicyStackAttachment is the policy-stack attachment viewed from the Policy.
PublicWorkerPool contains details of public worker pool for account.
PullRequest is Spacelift's representation of Pull Request on GitHub.
Metadata for a Pulumi output.
Metadata for a Pulumi resource.
Metadata for a Pulumi stack.
GitHub repository with branches.
Run represents the main concept in Spacelift.
RunComment represents a single comment on a Run.
Experimental: Response to marking a dependency as complete.
RunPolicyReceipt represents a single policy evaluation event that affected a Run.
RunResourceState represents a state of the Run. It's for Terraform-Provider, to allow spacelift run to read the state of another run.
RunReview represents a single Run review event.
Change in the Run state, along with its metadata.
RunWithPosition is a wrapper for run with its position in the queue.
RunWithPositionConnection represents a single queued run in a page of results.
RuntimeConfig is the runtime configuration pulled from GitHub for each Run separately.
SAMLSettings represent account's SAML settings
SampledPolicyLibrary represents a single policy library captured as part of a policy evaluation sample.
SearchModulesOutput is a page of Modules.
SearchNotificationsOutput is a page of Notifications.
SearchStacksOutput is a page of Stacks.
SearchSuggestionsField describes a field you can use for searching.
SearchSuggestionsOutput describes fields you can use for searching.
SearchSuggestionsPossibleValuesBoolean describes possible boolean values of a field.
SearchSuggestionsPossibleValuesEnum describes possible enum values of a field.
SearchSuggestionsPossibleValuesHierarchy describes possible values of a hierarchical field.
SearchSuggestionsPossibleValuesHierarchyNode describes a single possible value node of a hierarchical field.
SearchSuggestionsPossibleValuesString describes possible string values of a field.
SecurityKey represents hardware device that supports the FIDO2 protocol.
Session represents a single user session with a Spacelift account.
SharedModule contains information about a module an account has access to that is shared with it by another Spacelift account.
SharedModule contains information about a module version that has been shared with this account by another Spacelift account.
Returns information about the Slack App used to integrate Spacelift with Slack.
SlackIntegration represents account's Slack integration
SpaceActions define which actions are allowed in a space.
Stack represents a single Spacelift project.
StackAwsIntegrationAttachment is the AWS integration attachment viewed from the Stack.
StackAzureIntegrationAttachment is the Azure integration attachment viewed from the Stack.
Configuration specific to Ansible stacks.
Configuration specific to CloudFormation stacks.
Configuration specific to Kubernetes stacks.
Configuration specific to Pulumi stacks.
Configuration specific to Terraform stacks.
Configuration specific to Terragrunt stacks.
StackConnection represents a single stack in a page of results.
StackContextAttachment is the stack attachment viewed from the Stack.
StackDependency represents a dependency between two stacks.
AWS integration - with that set up, a Stack can assume an arbitrary AWS IAM role without setting up static credentials.
GCP integration - with that set up, a Stack gets its dedicated GCP service account and each run and tasks automatically gets its temporary credentials.
Slack integration - with that set up, a Stack or Module can send notifications about various events to a number of Slack channels.
StackIntegrations represents external integrations for an individual Stack.
StackOutput represents a single stack output field.
StackPolicyAttachment is the stack policy attachment viewed from the Stack.
StateUploadUrl represents a pre-signed URL that can be used to upload an existing state file.
Metadata for a Terraform module.
Metadata for a Terraform output.
TerraformProvider represents a Terraform provider managed using Spacelift's Terraform provider registry.
Platform supported by Spacelift.
A single version of a managed Terraform provider.
A single artifact associated with a Terraform provider version.
Metadata for a Terraform resource.
Spacelift user.
UserLogin represents the last login attempt for a single GitHub user.
VCSAgentConnection represents a single connection from a VCS Agent.
VCSIntegrationUser represents a user (module or stacks) of the VCS integration.
VCSIntegrationUserConnection represents a single stack/module in a page of results for a VCS integration.
Version represents a single version of the Module.
Contains information about the module that a version was created from.
WebhookDeliveries represents a paginated list of webhook deliveries.
WebhookDelivery represents a single webhook or audit trail delivery.
WebhookDeliveryDetails represents extended details for a single webhook delivery.
WebhookDeliveryHeader represents a single header (request or response) in a webhook delivery.
Webhooks integration info to send webhooks for stack
Worker represents a single worker in the WorkerPool.
WorkerConnection represents a single worker in a page of results.
WorkerPool represents a single WorkerPool.
WorkerPoolConnection represents a single worker pool in a page of results.
WorkerPoolUser represents a user (module or stacks) of the worker pool.
WorkerPoolUserConnection represents a single stack/module in a page of results for a worker pool.
A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.
One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.
Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.
Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.
A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.
The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.