Skip to content

One version, and optionally one of its files

OpenAPI JSON
GET
/v1/apps/{app}/versions/{version}
curl --request GET \
  --url https://api.eu.apigami.com/v1/apps/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/versions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Where the version stands: validation, deployment, health, review and what blocks its publication (publish). No file is returned unless path names one, cut by from and to; base_version_id asks for a diff.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
app
required
string format: uuid
version
required
string format: uuid

Query Parameters

Section titled “Query Parameters”
path
string
<= 320 characters
from
integer
>= 1
to
integer
>= 1
base_version_id
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

The version.

Media typeapplication/json

Where one version stands. publish.next is the one sentence to act on.

object
version_id
required
string format: uuid
app_id
required
string format: uuid
base_version_id
string | null format: uuid
state
required

ready once written, deployed, pending_review, rejected, among others.

string
validation
required
object
status
string
Allowed values: valid invalid
errors
integer
diagnostics
Array<object>
object
code
required
string
file
required
string | null
pointer
required

A JSON pointer into the file.

string | null
message
required

The fix.

string
level

Present on a warning, which blocks nothing.

string
Allowed values: warning
version

The info.version of its manifest.

string | null
production
boolean
deployed
boolean
address

Where its pages answer, from the slug of its manifest.

object
production
string format: uri
staging
string format: uri
health
object
state
string | null
checked_at
string | null format: date-time
error
string | null
tried_at

When one of its actions first answered below 500 on its own deployment, which publication requires.

string | null format: date-time
publish
required
object
publishable
required
boolean
production
required
boolean
review_required
boolean
blockers
required
Array<object>
object
code
required
string
message
required
string
next
required
string
created_at
string format: date-time
published_at
string | null format: date-time
Example
{
  "validation": {
    "status": "valid",
    "diagnostics": [
      {
        "level": "warning"
      }
    ]
  }
}

404

Section titled “404”

Not a version of an application of your team.

Media typeapplication/json
object
error
required
string
consentPending

Present and true when the approval window is open and the user has not answered within 45 s.

boolean
Example
{
  "error": "not found"
}