Skip to content

Update a realm

POST
/api/v1/realms/{name}/update
curl --request POST \
--url http://localhost:11044/api/v1/realms/example/update \
--header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Pulls the latest changes for a realm backed by a git checkout. A realm loaded from a local path reference has no checkout to pull; it reports as already live.

name
required
string

Realm name

Realm updated, or already live for a local reference

Media type*/*
object
key
additional properties
string

Realm not found

Media type*/*

A refusal from the realms surface: the word error and the reason

object
message
required

Why the request was refused, written to be shown. A failed install or update carries the underlying failure’s message

string
status
required

Always error

string
Allowed values: error

Update failed

Media type*/*

A refusal from the realms surface: the word error and the reason

object
message
required

Why the request was refused, written to be shown. A failed install or update carries the underlying failure’s message

string
status
required

Always error

string
Allowed values: error