Prepare image upload

Reserves a named image tag and returns five-minute direct-upload credentials. Supply the image ID to refresh the same reservation.

Required permission

Project > Images > General > Import

Path parameters

projectId
string required
ID of the project

Request body

{object}

name
string required
min length
1
max length
128
pattern
^[a-z0-9]+(?:[._-][a-z0-9]+)*$
tag
string required
pattern
^[A-Za-z0-9_][A-Za-z0-9_.-]{0,127}$
imageId
string
min length
24
max length
24

Response body

{object}
Response object.

data
{object} required
Result data.

registryUrl
string required
repository
string required
imageId
string required
min length
24
max length
24
token
string required
expiresAt
string required

POST /v1/projects/{projectId}/images/upload-credentials

POST /v1/teams/{teamId}/projects/{projectId}/images/upload-credentials

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"name":"string","tag":"string"}' \
  https://api.northflank.com/v1/projects/{projectId}/images/upload-credentials

Example response

200 OK

Scoped direct-upload credentials.

JSON