Create a new deployment

POSThttps://api.ridgeline.run/v13/deploymentsOpenAPI spec

Creates a deployment from files or a Git reference.

Parameters

teamIdstringquery

The team identifier to perform the request on behalf of.

slugstringquery

The team slug to perform the request on behalf of.

Request body

namestringrequired

The project to deploy to.

targetstring

Where the deployment is promoted.

production | preview

gitSourceobject

The Git reference to build.

Show child parameters

refstring

repoIdstring

{
  "name": "string",
  "target": "production",
  "gitSource": {
    "ref": "string",
    "repoId": "string"
  }
}

Code samples

TypeScript

const res = await fetch('https://api.ridgeline.run/v13/deployments?teamId=&slug=', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"name":"string","target":"production","gitSource":{"ref":"string","repoId":"string"}}),
});
const data = await res.json();

cURL

curl -X POST "https://api.ridgeline.run/v13/deployments?teamId=&slug=" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","target":"production","gitSource":{"ref":"string","repoId":"string"}}'

Python

import requests

res = requests.request(
    "POST",
    "https://api.ridgeline.run/v13/deployments?teamId=&slug=",
    headers={
    "Content-Type": "application/json",
    },
    json={"name": "string", "target": "production", "gitSource": {"ref": "string", "repoId": "string"}},
)
data = res.json()

Responses

200 OK

Example

{
  "id": "dpl_2k9x",
  "url": "my-app-8f3k2.ridgeline.app",
  "readyState": "QUEUED"
}

Schema

idstring

urlstring

readyStatestring

400 One of the provided values is invalid.

403 You do not have permission to access this resource.

Was this helpful?

const res = await fetch('https://api.ridgeline.run/v13/deployments?teamId=&slug=', { method: 'POST', headers: { 'Content-Type': 'application/json', }, body: JSON.stringify({"name":"string","target":"production","gitSource":{"ref":"string","repoId":"string"}}), }); const data = await res.json();

curl -X POST "https://api.ridgeline.run/v13/deployments?teamId=&slug=" \ -H "Content-Type: application/json" \ -d '{"name":"string","target":"production","gitSource":{"ref":"string","repoId":"string"}}'

import requests res = requests.request( "POST", "https://api.ridgeline.run/v13/deployments?teamId=&slug=", headers={ "Content-Type": "application/json", }, json={"name": "string", "target": "production", "gitSource": {"ref": "string", "repoId": "string"}}, ) data = res.json()