Skip to main content

CreateChangeSetPayload

fileSourceSchemestring

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.

Possible values: [file, s3, gcs, azureblob, https]

Default value: file
Example: file
directorystringrequired

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 base URL to the blueprint document excluding the scheme. An example for a https source would be example.com/path/to/blueprint-directory.

Example: /path/to/blueprint-directory
blueprintFilestring

The name of the blueprint file to use to stage changes.

Default value: project.blueprint.yml
Example: project.blueprint.yml
instanceIdstring

The ID of an existing blueprint instance to stage changes for. If this is not provided and an instance name is not provided, a change set for a new blueprint instance deployment will be created.

This should be left empty if the instanceName field is provided.

Example: a471bbb8-1267-4e65-873b-fa86bca71fcf
instanceNamestring

The user-defined name of an existing blueprint instance to stage changes for. If this is not provided and an instance ID is not provided, a change set for a new blueprint instance deployment will be created.

This should be left empty if the instanceId field is provided.

Example: my-instance
destroyboolean

If true, the change set will be created for a destroy operation. This will only be used if the instanceId or instanceName fields are provided. If this is not provided, the default value is false.

Default value: false
Example: false
CreateChangeSetPayload
{
  "fileSourceScheme": "file",
  "directory": "/path/to/blueprint-directory",
  "blueprintFile": "project.blueprint.yml",
  "instanceId": "a471bbb8-1267-4e65-873b-fa86bca71fcf",
  "instanceName": "my-instance",
  "destroy": false
}