Blueprint
Blueprint-ObservabilityTools

Preview Dockerfile definition for a Blueprint.

Changed on

Preview building a Blueprint with the specified configuration. You can take the resulting Dockerfile and test out your build using any local docker tooling.

post/v1/blueprints/preview

Request

  • Base URL: https://api.runloop.ai
  • URL: https://api.runloop.ai/v1/blueprints/preview
  • Auth: HTTP bearer

Request body

namestring required

Name of the Blueprint.

dockerfilestring nullable

Dockerfile contents to be used to build the Blueprint.

system_setup_commandsstring[] nullable

A list of commands to run to set up your system.

file_mountsobject nullable

(Optional) Map of paths and file contents to write before setup.

base_blueprint_idstring nullable

(Optional) ID of previously built blueprint to use as a base blueprint for this build.

base_blueprint_namestring nullable

(Optional) Name of previously built blueprint to use as a base blueprint for this build. When set, this will load the latest successfully built Blueprint with the given name. Only one of (base_blueprint_id, base_blueprint_name) should be specified.

metadataobject nullable

(Optional) User defined metadata for the Blueprint.

build_argsobject nullable

(Optional) Arbitrary Docker build args to pass during build.

secretsobject nullable

(Optional) Map of mount IDs/environment variable names to secret names. Secrets will be available to commands during the build. Secrets are NOT stored in the blueprint image. Example: {"DB_PASS": "DATABASE_PASSWORD"} makes the secret 'DATABASE_PASSWORD' available as environment variable 'DB_PASS'.

network_policy_idstring nullable

(Optional) ID of the network policy to apply during blueprint build. This restricts network access during the build process. This does not affect devboxes created from this blueprint; if you want devboxes created from this blueprint to inherit the network policy, set the network_policy_id on the blueprint launch parameters.

Response

OK

dockerfilestring required

The Dockerfile contents that will built.

Changes

  • b4ffb9a8aff3Revision changes
    • info

      added the new optional request property /////

  • d3ddb452754cRevision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property became not nullable

    • breaking

      removed from the request property oneOf list

    • breaking

      the request property type changed from object to no type

    • breaking

      the // request property type changed from object to no type

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • info

      added subschema #2 to the request property anyOf list

    • info

      added subschema #2 to the // request property anyOf list

    • info

      added subschema #2 to the request property anyOf list

    • info

      removed discriminator from request property