Jump to

• Request
• Response

Get a snapshot

get

https://{your_site_interface}/opa-hub/api/12.2.35/deployments/{deployment-name}/activeVersion/snapshot

This operation will get a deployment snapshot as a base-64 encoded string. To receive a deployment snapshot as binary data, send an HTTP Accept header of "Accept: application/zip".

Request

Path Parameters

• deployment-name(required): string
  The name of the deployment.

Query Parameters

• expand: string
  Comma separated list of named resources to expand, or "all" to expand all
• fields: string
  Comma separated list of fields to be returned
• links: string
  Comma separated list of links to be returned, or "none" to omit links

There's no request body for this operation.

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json
• application/zip

200 Response

The request was successfully completed.

Body ()

Root Schema : snapshot

Type: object

Show Source

• base64(required): string (byte)
  The zipped project to be deployed, as base-64 encoded data.

  Example: QmFzZS02NCBkYXRhLg==

{
    "type":"object",
    "properties":{
        "base64":{
            "type":"string",
            "format":"byte",
            "description":"The zipped project to be deployed, as base-64 encoded data.",
            "example":"QmFzZS02NCBkYXRhLg=="
        }
    },
    "additionalProperties":false,
    "required":[
        "base64"
    ]
}

304 Response

The resource wasn't modified according to the ETag that was provided.

404 Response

The requested resource does not exist.

410 Response

The requested resource is no longer available.

412 Response

The resource state on the server side doesn't match the provided ETag.

Back to Top