Create a source tag - Spacefast Docs
Create a source tag
Create a release tag in a ready source connection.
Request
POST /v1/spaces/{spaceId}/source/tags
Authorization
Authorization Bearer token · header required
Authorization: Bearer <token> with an API key (sfa_ prefix), an OAuth access token, a session token, or a Space machine credential (sfm_ prefix).
or
Authorization OAuth2 access token · header required
OAuth 2.0 with Spacefast scopes. People use the authorization code flow; machines use client credentials.
Scopes: spaces:write
Path parameters
spaceId string required
Request body
required application/json
connectionTypestring required
Allowed:connected,hostednamestring required
Tag name to create.
min length 1targetstring required
Branch, tag, or commit the tag points at.
min length 1
Responses
201 Response for status 201
$schemastring- Canonical JSON Schema URL for this response body. The server also sends it in the
Link: rel="describedby"response header.
- Canonical JSON Schema URL for this response body. The server also sends it in the
dataobject requiredrepositoryConnectionobject requiredidstring required
Source connection ID (rpc_prefix).spaceIdstring requiredproviderstring required
Git host the repository lives on.
Allowed:github,gitlab,bitbucket,genericconnectionTypestring requiredconnectedfor a repository linked from a Git host,hostedfor the mirror Spacefast hosts and the caller pushes to. Allowed:connected,hostedrepositoryIdstring | any required Identifier of the mirror that content reads and builds run against. Null when no mirror is bound yet.installationIdstring | any required
GitHub App installation the connection reads through. Null for a hosted mirror. default: nullcloneUrlConfiguredboolean required
Whether a clone URL is stored. The URL itself is not returned. default: falseupstreamUrlConfiguredboolean required
Whether an upstream URL to pull from is stored. The URL itself is not returned. default: falserepositoryNamestring required
Repository name without its owner.repositoryFullNamestring required
Repository name asowner/name.defaultBranchstring required
Branch the Git host treats as the repository default.productionBranchstring required
Branch whose pushes produce production builds, and the ref content reads fall back to when none is given.credentialConfiguredboolean required
Whether a Git credential is stored. The credential itself is never returned.autoDeployProductionboolean required
Whether a push to the production branch queues a build.autoDeployPreviewsboolean required
Whether a push to any other branch or a pull request queues a preview build.buildSettingsobject requiredrootDirectorystring | any required Directory the build runs in, relative to the source root. Null builds at the root. default: nullinstallDirectorystring | any required Directory dependencies install into, relative to the source root. Null installs in the build directory. default: nullinstallCommandstring | any required Command that installs dependencies. Null lets the build runner pick one. default: nullbuildCommandstring | any required Command that produces the output. Null lets the build runner pick one. default: nulloutputDirectorystring | any required Directory the built output is collected from, relative to the build directory. Null lets the build runner detect it. default: nullignoredBuildCommandstring | any required Command run before the build to decide whether the build is needed. Exiting 0 ends the build asskipped; any other exit code continues. Null always builds. default: nullframeworkPresetstring | any required
Framework the source builds with, for examplenextorvite. Null lets the build runner detect it. default: nullplatformPresetstring | any required
Platform build convention the source follows, for examplevercelornetlify. Null lets the build runner detect it. default: nullallowUnsupportedPlatformFeaturesboolean required Runs the build even when the source declares platform features Spacefast does not support. Defaults tofalse, which refuses those sources. default: falsetimeoutSecondsinteger required
Wall-clock budget for the run, in seconds. Between 60 and 7200; defaults to 900. min 60 · max 7200 · default: 900syncStatusstring requiredidlebefore the first sync,syncingwhile one runs,readyonce content reads work,failedwhen the last one did not finish. Allowed:idle,syncing,ready,failedproviderAccessStatusstring required
Whether the Git host still grants access. Anything other thanactiveblocks builds until the caller reinstalls or reauthorizes. default: "active" Allowed:active,suspended,revoked,reauthorization_requiredproviderAccessErrorstring | any required
What the Git host reported when access stopped working. Null while access holds. default: nulllastSyncedAtstring| any required ISO 8601 timestamp of the last sync that finished. Null before the first one. lastSyncErrorstring | any required
Why the last sync failed. Null after a sync that succeeded.syncRunIdstring | any required
Identifier of the sync in flight. Null when no sync is running.connectedUserIdstring | any required
User who last authorized or changed the connection. Null when no user did.createdAtstringrequired ISO 8601 timestamp when the connection was created. updatedAtstringrequired ISO 8601 timestamp of the last change.
repositoryIdstring requiredtagobject requirednamestring requiredshastring requiredmessagestring required
Error Response
default Error. Every 4xx and 5xx response is one RFC 9457 problem document served as application/problem+json.