Path parameters

• machineSlug string Required

  The slug/name for the machine definition this version is related to.

  Minimum length is 1. Format should match the following pattern: ^[a-zA-Z0-9_-]{1,128}$.

Query parameters

• gzip boolean

  Will the code be uploaded gzipped?

Responses

• 200

  The machine version migration was provisionally created successfully.

  Now, post the code for the machine version migration as follows:

  const { codeUploadFields, codeUploadUrl } = await provisionalVersionMigrationCreationResponse.json();
  const uploadForm = new FormData();
  for (const [key, value] of Object.entries(codeUploadFields)) {
    uploadForm.append(key, value as string);
  }
  uploadForm.set("content-type", "application/javascript");
  uploadForm.append(
    "file",
    new Blob(["javascript-code-here"], {
      type: "application/javascript",
    }),
    "your-file-name.js",
  );
  const uploadRes = await fetch(
    codeUploadUrl,
    {
      method: "POST",
      body: uploadForm,
    },
  );
  

  And then finalize the creation of the machine version migration by calling PUT /machines/:machineSlug/migrations/:machineVersionMigrationId with the machineVersionMigrationId returned from this operation.

  Hide response attributes Show response attributes object

  • machineVersionMigrationId string Required

    The signed machine version migration ID.

  • codeUploadUrl string Required

    The URL to upload the machine definition version code to.

  • codeUploadFields object Required

    The fields that must be included as form data in the upload request.

    Hide codeUploadFields attribute Show codeUploadFields attribute object

    • Additional properties: string
• 403

  The request was unauthorized.

  Hide response attributes Show response attributes object

  • error string

    A description of the error.

  • code string

    A code specifying the type of error.

    Values are missing-scope, rejected-by-machine-authorizer, missing-user, or missing-org.

• 400

  The request was malformed.

  Hide response attributes Show response attributes object

  • error string

    A description of the error.

  • code string

    A code specifying the type of error.

    • specify-org indicates that the user has access to multiple orgs and the operation requires specifying an organization. Pass the x-statebacked-org-id header to specify an org ID.
    • invalid-parameter indicates that one of the provided parameters was incorrect

    Values are specify-org or invalid-parameter.

  • parameter string

    The name of the invalid parameter