Instance

The immutable serving identity of this LeapView installation.

Operations

Each operation lists its specific responses. See Common error responses for errors shared by every operation on this page.

Get this LeapView instance identity

GET /api/v1/instance

Operation ID: getInstance
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Responses

Status	Description
`200`	The request has succeeded.
`415`	Generated transport error

Get safe API and protocol availability

GET /api/v1/instance/api-status

Operation ID: getProductAPIStatus
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Responses

Status	Description
`200`	The request has succeeded.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`404`	The server cannot find the requested resource.
`409`	The request conflicts with the current state of the server.
`412`	Precondition failed.
`413`	Client error
`415`	Client error
`422`	Client error
`502`	Server error

Get redacted authentication configuration status

GET /api/v1/instance/authentication

Operation ID: getProductAuthenticationStatus
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Responses

Status	Description
`200`	The request has succeeded.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`404`	The server cannot find the requested resource.
`409`	The request conflicts with the current state of the server.
`412`	Precondition failed.
`413`	Client error
`415`	Client error
`422`	Client error
`502`	Server error

Remove the product logo

DELETE /api/v1/instance/logo

Operation ID: deleteProductLogo
Effect: destructive
Confirmation: required
Focused reference: JSON · Markdown

Parameters

Name	In	Required	Type	Description
`If-Match`	header	Yes	string

Responses

Status	Description
`200`	The request has succeeded.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`404`	The server cannot find the requested resource.
`409`	The request conflicts with the current state of the server.
`412`	Precondition failed.
`413`	Client error
`415`	Client error
`422`	Client error
`502`	Server error

Upload the product logo

PUT /api/v1/instance/logo

Operation ID: uploadProductLogo
Effect: idempotent-write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Name	In	Required	Type	Description
`If-Match`	header	Yes	string
`Content-Type`	header	Yes	string

Request body

Content types: */*.

Responses

Status	Description
`200`	The request has succeeded.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`404`	The server cannot find the requested resource.
`409`	The request conflicts with the current state of the server.
`412`	Precondition failed.
`413`	Client error
`415`	Client error
`422`	Client error
`502`	Server error

Read an immutable product logo

GET /api/v1/instance/logo/{digest}

Operation ID: getProductLogo
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Parameters

Name	In	Required	Type	Description
`digest`	path	Yes	string

Responses

Status	Description
`200`	The request has succeeded.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`404`	The server cannot find the requested resource.
`409`	The request conflicts with the current state of the server.
`412`	Precondition failed.
`413`	Client error
`415`	Client error
`422`	Client error
`502`	Server error

Get mutable product identity

GET /api/v1/instance/settings

Operation ID: getProductSettings
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Responses

Status	Description
`200`	The request has succeeded.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`404`	The server cannot find the requested resource.
`409`	The request conflicts with the current state of the server.
`412`	Precondition failed.
`413`	Client error
`415`	Client error
`422`	Client error
`502`	Server error

Update mutable product identity

PATCH /api/v1/instance/settings

Operation ID: updateProductSettings
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Name	In	Required	Type	Description
`If-Match`	header	Yes	string

Request body

Content types: application/json.

Responses

Status	Description
`200`	The request has succeeded.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`404`	The server cannot find the requested resource.
`409`	The request conflicts with the current state of the server.
`412`	Precondition failed.
`413`	Client error
`415`	Client error
`422`	Client error
`502`	Server error

Reset mutable product identity to its defaults

POST /api/v1/instance/settings/reset

Operation ID: resetProductSettings
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Name	In	Required	Type	Description
`Idempotency-Key`	header	Yes	string
`If-Match`	header	Yes	string

Responses

Status	Description
`200`	The request has succeeded.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`404`	The server cannot find the requested resource.
`409`	The request conflicts with the current state of the server.
`412`	Precondition failed.
`413`	Client error
`415`	Client error
`422`	Client error
`502`	Server error

Get redacted system status

GET /api/v1/instance/system

Operation ID: getProductSystemStatus
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Responses

Status	Description
`200`	The request has succeeded.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`404`	The server cannot find the requested resource.
`409`	The request conflicts with the current state of the server.
`412`	Precondition failed.
`413`	Client error
`415`	Client error
`422`	Client error
`502`	Server error

Common error responses

These error responses apply to every operation on this page.

Status	Description
`400`	The server could not understand the request due to invalid syntax.
`429`	Client error
`500`	Server error
`503`	Service unavailable.