Create a Blueprint Validation

Create a blueprint validation. This will start a validation process for the provided blueprint document and return an ID that can be used to retrieve validation metadata or stream validation events as they occur.

Authorization

AuthorizationBearer <token>

OAuth2/OIDC auth using JWT Bearer tokens. The token issuer will be configured independently for each Deploy Engine instance.

In: header

Query Parameters

checkBlueprintVars?boolean

If set to true or 1, the blueprint validation process will check that the provided blueprint variables are valid for the blueprint. By default, the blueprint validation process will not check the provided blueprint variables.

Defaultfalse

checkPluginConfig?boolean

If set to true or 1, the blueprint validation process will check that the provided plugin configuration is valid against the plugin config schemas defined by the plugins installed for the Deploy Engine instance. By default, the blueprint validation process will not check the provided plugin configuration.

Defaultfalse

Header Parameters

Bluelink-Signature-V1?string

The Bluelink Signature v1 authentication mechanism can be used to authenticate requests to the Deploy Engine. See the Bluelink Signature v1 documentation for more information on how to use this authentication mechanism. This is not required if the request is authenticated using an OAuth2/OIDC-issued JWT or an API key.

Request Body

Payload for creating a new blueprint validation.

fileSourceScheme?string

The file source scheme to determine where the blueprint document is located.

This can be one of the following:

file: The blueprint document is located on the local file system of the Deploy Engine server.
s3: The blueprint document is located in an S3 bucket.
gcs: The blueprint document is located in a GCS bucket.
azureblob: The blueprint document is located in an Azure Blob Storage container.
https: The blueprint document is located via a public HTTPS URL.

For remote source authentication, the Deploy Engine server will need to be configured with the appropriate credentials to access the remote source. Authentication is not supported for https sources.

Default"file"

Value in"file" | "s3" | "gcs" | "azureblob" | "https"

directorystring

The directory where the blueprint document is located. For file sources, this must be an absolute path to the directory on the local file system of the Deploy Engine server. An example for a file source would be /path/to/blueprint-directory. For s3, gcs and azureblob sources, this must be the path to the virtual directory where the first path segment is the bucket/container name and the rest of the path is the path to the virtual directory. An example for a remote object storage source would be bucket-name/path/to/blueprint-directory. For https sources, this must be the path to the blueprint document, a host must be supplied in the blueprintLocationMetadata field. An example for a https source would be /path/to/blueprint-directory with a blueprintLocationMetadata.host field set to example.com.

blueprintFile?string

The name of the blueprint file to validate.

Default"project.blueprint.yml"

blueprintLocationMetadata?BlueprintLocationMetadata

Additional metadata about the location of the blueprint document. For example, this can be used to specify the region of the bucket or container where the blueprint document is located in a cloud object storage service. This only supports scalar values.

Empty Object

config?Config

Configuration used for carrying out actions for blueprints. This consists of environment configuration (context-wide), provider and transformer plugin specific configuration along with blueprint variables.

Response Body

curl -X POST "https://{host}/{basePath}/v1/validations?checkBlueprintVars=false&checkPluginConfig=false" \
  -H "Bluelink-Signature-V1: string" \
  -H "Content-Type: application/json" \
  -d '{
    "directory": "/path/to/blueprint-directory"
  }'

curl -X POST "https://{host}/{basePath}/v1/validations?checkBlueprintVars=false&checkPluginConfig=false" \  -H "Bluelink-Signature-V1: string" \  -H "Content-Type: application/json" \  -d '{    "directory": "/path/to/blueprint-directory"  }'

{
  "id": "60d7c6c5-3984-42b9-a3c1-ae8a47a9bf55",
  "status": "VALIDATING",
  "blueprintLocation": "file:///path/to/blueprint-directory/project.blueprint.yml",
  "created": 1678901234
}

{
  "message": "Bad request"
}

{
  "message": "Unauthorized"
}

{
  "message": "Input validation failed",
  "errors": [
    {
      "location": "body",
      "message": "Value must be one of the following: [aws, azure]",
      "type": "oneof"
    }
  ],
  "validationDiagnostics": [
    {
      "message": "Incorrect blueprint version",
      "level": 1,
      "range": {
        "start": {
          "line": 1,
          "column": 1,
          "endPosition": {
            "line": 1,
            "column": 1
          }
        },
        "end": {
          "line": 1,
          "column": 1,
          "endPosition": {
            "line": 1,
            "column": 1
          }
        },
        "columnAccuracy": 1
      }
    }
  ]
}

{
  "message": "An unexpected error occurred"
}