Create deployment

Create a deployment for an app in a project.

Omit the source to use the app’s configured default. A Git app builds its default branch. An OCI app deploys its default image.

Optionally provide one source override:

oci: deploy a prebuilt OCI image without a build. Mutable tags are resolved to immutable digests before rollout.
git: build and deploy from the app’s connected GitHub repository, a branch, a specific commit, or a fork commit. Requires the app to have a repository connected.
deployment: re-run an existing deployment by its id. Git deployments rebuild from the recorded commit; OCI deployments reuse the recorded resolved image.

Returns immediately with a deploymentId. The build and rollout run asynchronously. Poll deployments.getDeployment to watch status until it is ready.

Authentication: requires a root key with permission to create deployments.

POST

deployments.createDeployment

Go (SDK)

package main

import(
	"context"
	"os"
	unkey "github.com/unkeyed/sdks/api/go/v3"
	"github.com/unkeyed/sdks/api/go/v3/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := unkey.New(
        unkey.WithSecurity(os.Getenv("UNKEY_ROOT_KEY")),
    )

    res, err := s.Deployments.CreateDeploymentV3(ctx, components.V3DeploymentsCreateDeploymentRequestBody{
        Project: "proj_1234abcd",
        App: "proj_1234abcd",
        Environment: "proj_1234abcd",
        Git: &components.DeploymentSourceGit{
            Branch: unkey.Pointer("main"),
            CommitSha: unkey.Pointer("9f2c1a7"),
            Repository: unkey.Pointer("contributor/acme-api"),
        },
        Oci: &components.DeploymentSourceOCI{
            Image: "ghcr.io/acme/api:v1.2.3",
        },
        Deployment: &components.DeploymentSourceDeployment{
            DeploymentID: "proj_1234abcd",
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V3DeploymentsCreateDeploymentResponseBody != nil {
        // handle response
    }
}

curl --request POST \
  --url https://api.unkey.com/v3/deployments.createDeployment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project": "proj_1234abcd",
  "app": "proj_1234abcd",
  "environment": "proj_1234abcd",
  "git": {
    "branch": "main",
    "commitSha": "9f2c1a7",
    "repository": "contributor/acme-api"
  }
}
'

import requests

url = "https://api.unkey.com/v3/deployments.createDeployment"

payload = {
    "project": "proj_1234abcd",
    "app": "proj_1234abcd",
    "environment": "proj_1234abcd",
    "git": {
        "branch": "main",
        "commitSha": "9f2c1a7",
        "repository": "contributor/acme-api"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    project: 'proj_1234abcd',
    app: 'proj_1234abcd',
    environment: 'proj_1234abcd',
    git: {branch: 'main', commitSha: '9f2c1a7', repository: 'contributor/acme-api'}
  })
};

fetch('https://api.unkey.com/v3/deployments.createDeployment', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unkey.com/v3/deployments.createDeployment",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'project' => 'proj_1234abcd',
    'app' => 'proj_1234abcd',
    'environment' => 'proj_1234abcd',
    'git' => [
        'branch' => 'main',
        'commitSha' => '9f2c1a7',
        'repository' => 'contributor/acme-api'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://api.unkey.com/v3/deployments.createDeployment")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project\": \"proj_1234abcd\",\n  \"app\": \"proj_1234abcd\",\n  \"environment\": \"proj_1234abcd\",\n  \"git\": {\n    \"branch\": \"main\",\n    \"commitSha\": \"9f2c1a7\",\n    \"repository\": \"contributor/acme-api\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unkey.com/v3/deployments.createDeployment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"project\": \"proj_1234abcd\",\n  \"app\": \"proj_1234abcd\",\n  \"environment\": \"proj_1234abcd\",\n  \"git\": {\n    \"branch\": \"main\",\n    \"commitSha\": \"9f2c1a7\",\n    \"repository\": \"contributor/acme-api\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "deploymentId": "d_abc123xyz"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found",
    "errors": [
      {
        "location": "body.permissions[0].name",
        "message": "Must be at least 3 characters long",
        "fix": "Ensure the name uses only alphanumeric characters, underscores, and hyphens"
      }
    ]
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

Authorizations

Authorization

string

header

required

Unkey uses bearer tokens for authentication. Public integrations use root keys, while the dashboard proxy uses short-lived JWTs. To authenticate, include the token in the Authorization header of each request:

Authorization: Bearer unkey_123

Root keys have specific permissions attached to them, controlling what operations they can perform. Legacy permissions use tuple strings like api.*.create_key; resource permissions use Unkey Resource Names plus actions, like unkey:v1:ws_123:keyspaces/*#create_key. Security best practices:

Keep root keys secure and never expose them in client-side code
Use different root keys for different environments
Rotate keys periodically, especially after team member departures
Create keys with minimal necessary permissions following least privilege principle
Monitor key usage with audit logs.

Body

application/json

Create a deployment. Omit the source to use the app default, or provide one source override.

project

string

required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Required string length: 3 - 255

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"proj_1234abcd"

app

string

required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Required string length: 3 - 255

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"proj_1234abcd"

environment

string

required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Required string length: 3 - 255

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"proj_1234abcd"

git

object

Build from the app's connected GitHub repository.

Show child attributes

oci

object

Deploy a prebuilt OCI image without a build.

Show child attributes

deployment

object

Re-run an existing deployment.

Show child attributes

Response

Deployment created successfully

meta

object

required

Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The requestId is particularly important when troubleshooting issues with the Unkey support team.

Show child attributes

data

object

required

Show child attributes

Last modified on September 18, 2026

⌘I

Go (SDK)

package main

import(
	"context"
	"os"
	unkey "github.com/unkeyed/sdks/api/go/v3"
	"github.com/unkeyed/sdks/api/go/v3/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := unkey.New(
        unkey.WithSecurity(os.Getenv("UNKEY_ROOT_KEY")),
    )

    res, err := s.Deployments.CreateDeploymentV3(ctx, components.V3DeploymentsCreateDeploymentRequestBody{
        Project: "proj_1234abcd",
        App: "proj_1234abcd",
        Environment: "proj_1234abcd",
        Git: &components.DeploymentSourceGit{
            Branch: unkey.Pointer("main"),
            CommitSha: unkey.Pointer("9f2c1a7"),
            Repository: unkey.Pointer("contributor/acme-api"),
        },
        Oci: &components.DeploymentSourceOCI{
            Image: "ghcr.io/acme/api:v1.2.3",
        },
        Deployment: &components.DeploymentSourceDeployment{
            DeploymentID: "proj_1234abcd",
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V3DeploymentsCreateDeploymentResponseBody != nil {
        // handle response
    }
}

curl --request POST \
  --url https://api.unkey.com/v3/deployments.createDeployment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project": "proj_1234abcd",
  "app": "proj_1234abcd",
  "environment": "proj_1234abcd",
  "git": {
    "branch": "main",
    "commitSha": "9f2c1a7",
    "repository": "contributor/acme-api"
  }
}
'

import requests

url = "https://api.unkey.com/v3/deployments.createDeployment"

payload = {
    "project": "proj_1234abcd",
    "app": "proj_1234abcd",
    "environment": "proj_1234abcd",
    "git": {
        "branch": "main",
        "commitSha": "9f2c1a7",
        "repository": "contributor/acme-api"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    project: 'proj_1234abcd',
    app: 'proj_1234abcd',
    environment: 'proj_1234abcd',
    git: {branch: 'main', commitSha: '9f2c1a7', repository: 'contributor/acme-api'}
  })
};

fetch('https://api.unkey.com/v3/deployments.createDeployment', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unkey.com/v3/deployments.createDeployment",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'project' => 'proj_1234abcd',
    'app' => 'proj_1234abcd',
    'environment' => 'proj_1234abcd',
    'git' => [
        'branch' => 'main',
        'commitSha' => '9f2c1a7',
        'repository' => 'contributor/acme-api'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://api.unkey.com/v3/deployments.createDeployment")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project\": \"proj_1234abcd\",\n  \"app\": \"proj_1234abcd\",\n  \"environment\": \"proj_1234abcd\",\n  \"git\": {\n    \"branch\": \"main\",\n    \"commitSha\": \"9f2c1a7\",\n    \"repository\": \"contributor/acme-api\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unkey.com/v3/deployments.createDeployment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"project\": \"proj_1234abcd\",\n  \"app\": \"proj_1234abcd\",\n  \"environment\": \"proj_1234abcd\",\n  \"git\": {\n    \"branch\": \"main\",\n    \"commitSha\": \"9f2c1a7\",\n    \"repository\": \"contributor/acme-api\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "deploymentId": "d_abc123xyz"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found",
    "errors": [
      {
        "location": "body.permissions[0].name",
        "message": "Must be at least 3 characters long",
        "fix": "Ensure the name uses only alphanumeric characters, underscores, and hyphens"
      }
    ]
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}