Skip to main content
PUT
Error

Authorizations

Authorization
string
header
required

API token generated from the Goldsky Dashboard. Pass as: Authorization: Bearer

Path Parameters

name
string
required
Pattern: ^[a-zA-Z][\w-]*$
version
string
required
Pattern: ^[a-zA-Z0-9][\w+.-]*$

Body

multipart/form-data

Send each option as an ordinary multipart/form-data field, e.g. -F overwrite=0. Fields appear below as { value } because that is how a form field looks once parsed.

Send each option as an ordinary multipart/form-data field, e.g. -F overwrite=0. Fields appear below as { value } because that is how a form field looks once parsed.

bundle
object

Zip of the compiled subgraph build directory (graph build output), sent as a file part.

overwrite
object

Deprecated. Send "0" or omit it — "1" is rejected. To replace a version, delete it and deploy again, or move a tag to it.

remove_graft
object

Set to "1" to strip the graft from the manifest before deploying.

skip_graft_validation
object

Set to "1" to skip validation of the graft base subgraph.

start_block
object

Block number to start indexing from.

graft_from
object

name/version of an existing subgraph in this project to graft from.

description
object

Human-readable description (max 500 characters).

graph_node_shard
object

Advanced: pin the deployment to a specific indexing shard. Leave this unset unless Goldsky support asked you to set it.

Response

201 - application/json

Default Response

name
string
required
version
string
required
status
required
Available options:
ACTIVE
network
string
required
health
required
Available options:
HEALTHY
synced
boolean
required
graphql_endpoint
string
required
private_graphql_endpoint
string
required
public_endpoint_enabled
boolean
required
private_endpoint_enabled
boolean
required
description
string | null
required
deployments
object[]
required
tag
object