Cell API · Dashboard
Images, registry & webhooks
Manage registry images and tokens, registry credentials, image scans, and webhook triggers.
Base URL: https://api.hubfly.space. Use a Dashboard bearer token authorized for the project. Replace :projectId in each path with the Dashboard project ID. JSON routes use Content-Type: application/json.
How to use these endpoints
- List registry images and project registry settings before creating credentials or triggers.
- Store returned token secrets securely; scope webhook triggers to the expected source.
- Inspect scans or delivery logs when an image or automated deployment does not update.
List registry images
curl "https://api.hubfly.space/api/v1/projects/$PROJECT_ID/registry/images" \
-H "Authorization: Bearer $HUBFLY_TOKEN"The response uses the standard Dashboard envelope: ok, data, and meta on success. On failure, use the returned error code and message to decide whether to correct the request or retry. The exact schema and response codes for each operation are below.
Endpoint reference
Dashboard endpoints (26)
These JSON routes are served by the Hubfly space Dashboard API and use Dashboard project authorization.
DELETERemove stored git credentials for a projectDetails +/api/v1/projects/:projectId/git-credentials/delete
Deletes the stored git access token(s) for a project.
- If a host is specified, only the credential for that host is removed.
- If no host is specified, all git credentials for the project are deleted.
- Only requires the caller to be authenticated; no explicit project-level permission check beyond that.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
host | query | No | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "ok": { "const": true, "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "ok": true }, "meta": { "requestId": "string", "timestamp": "string" } }
GETList configured git hosts for a projectDetails +/api/v1/projects/:projectId/git-credentials
Returns the list of git hosts that have credentials configured for a project along with whether a token is currently stored for each host.
- Does not return the token values themselves.
- Only requires the caller to be authenticated.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "host": { "type": "string" }, "hasToken": { "type": "boolean" } }, "required": [ "host", "hasToken" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": [ { "host": "string", "hasToken": true } ], "meta": { "requestId": "string", "timestamp": "string" } }
PUTSet or replace a project's git access tokenDetails +/api/v1/projects/:projectId/git-credentials/update
Stores or updates a git access token for a project, scoped to a specific git host, used for authenticating git-based container builds against private repositories.
- Only requires the caller to be authenticated.
- The token is encrypted at rest.
- Updating a host that already has a token replaces it.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
accessToken | string | Yes |
host | string | Yes |
Complete request schema
{
"type": "object",
"properties": {
"accessToken": {
"type": "string"
},
"host": {
"type": "string"
}
},
"required": [
"accessToken",
"host"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "ok": { "const": true, "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "ok": true }, "meta": { "requestId": "string", "timestamp": "string" } }
GETList container images in a project's registryDetails +/api/v1/projects/:projectId/registry/images
Returns a paginated, optionally filtered list of container images stored in the project's registry, matching on image name, tag, or full registry reference.
- Each image includes storage billing fields: billable digest, size, layer count, and hourly/monthly storage cost.
- Each image includes an
isUsedflag indicating whether any container in the project currently references it. - Requires read access to the project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
query | query | No | string | — |
page | query | No | number | — |
pageSize | query | No | number | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "images": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "buildJobId": { "type": "string", "nullable": true }, "name": { "type": "string" }, "tag": { "type": "string" }, "registryRef": { "type": "string" }, "digest": { "type": "string", "nullable": true }, "sizeBytes": { "type": "number", "nullable": true }, "layerCount": { "type": "number", "nullable": true }, "os": { "type": "string", "nullable": true }, "architecture": { "type": "string", "nullable": true }, "sourceType": { "type": "string" }, "isUsed": { "type": "boolean" }, "billableDigest": { "type": "string", "nullable": true }, "billableSizeBytes": { "type": "number", "nullable": true }, "billableLayerCount": { "type": "number", "nullable": true }, "hourlyStorageCost": { "type": "string" }, "monthlyStorageCost": { "type": "string" }, "storageBillingStatus": { "type": "string", "nullable": true }, "lastStorageSyncedAt": { "type": "string", "nullable": true }, "createdByUserId": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastUsedAt": { "type": "string", "nullable": true }, "usedByContainers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "id", "projectId", "buildJobId", "name", "tag", "registryRef", "digest", "sizeBytes", "layerCount", "os", "architecture", "sourceType", "isUsed", "billableDigest", "billableSizeBytes", "billableLayerCount", "hourlyStorageCost", "monthlyStorageCost", "storageBillingStatus", "lastStorageSyncedAt", "createdByUserId", "createdAt", "updatedAt", "lastUsedAt", "usedByContainers" ], "additionalProperties": false } }, "total": { "type": "number" } }, "required": [ "images", "total" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "images": [ { "id": "string", "projectId": "string", "buildJobId": "string", "name": "string", "tag": "string", "registryRef": "string", "digest": "string", "sizeBytes": 0, "layerCount": 0, "os": "string", "architecture": "string", "sourceType": "string", "isUsed": true, "billableDigest": "string", "billableSizeBytes": 0, "billableLayerCount": 0, "hourlyStorageCost": "string", "monthlyStorageCost": "string", "storageBillingStatus": "string", "lastStorageSyncedAt": "string", "createdByUserId": "string", "createdAt": "string", "updatedAt": "string", "lastUsedAt": "string", "usedByContainers": [ { "id": "string", "name": "string" } ] } ], "total": 0 }, "meta": { "requestId": "string", "timestamp": "string" } }
POSTCopy a registry image into another projectDetails +/api/v1/projects/:projectId/registry/images/:imageId/copy
Duplicates an existing image's metadata (name, tag, digest, size, and labels) into a different target project, creating a new, independent image entry rather than moving the original.
- Requires read access to the source project.
- Requires admin-level (project:delete) permission on the target project.
- Triggers an
image.copiedwebhook event for the source project's registry webhooks.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
imageId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
targetProjectId | string | Yes |
Complete request schema
{
"type": "object",
"properties": {
"targetProjectId": {
"type": "string"
}
},
"required": [
"targetProjectId"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "tag": { "type": "string" }, "registryRef": { "type": "string" } }, "required": [ "id", "projectId", "name", "tag", "registryRef" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "id": "string", "projectId": "string", "name": "string", "tag": "string", "registryRef": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
DELETEDelete an image from the project registryDetails +/api/v1/projects/:projectId/registry/images/:imageId/delete
Permanently deletes an image from the project's registry.
- Returns a 409 if the image is marked as in use or is still referenced by a container's image source, to prevent removing images backing running containers.
- Dispatches an
image.deletedwebhook event. - Requires admin-level (project:delete) permission on the project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
imageId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "const": true, "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "success": true }, "meta": { "requestId": "string", "timestamp": "string" } }
GETGet details of a single registry imageDetails +/api/v1/projects/:projectId/registry/images/:imageId
Fetches a single image by ID within a project, including resolved billing fields (billable digest/size/layer count, hourly and monthly storage cost) and the list of containers currently using it.
- Returns a 404 if the image does not exist in the given project.
- Requires read access to the project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
imageId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "buildJobId": { "type": "string", "nullable": true }, "name": { "type": "string" }, "tag": { "type": "string" }, "registryRef": { "type": "string" }, "digest": { "type": "string", "nullable": true }, "sizeBytes": { "type": "number", "nullable": true }, "layerCount": { "type": "number", "nullable": true }, "config": { "type": "object", "properties": { "entrypoint": { "type": "array", "items": { "type": "string" } }, "cmd": { "type": "array", "items": { "type": "string" } }, "env": { "type": "array", "items": { "type": "string" } }, "workingDir": { "type": "string" }, "user": { "type": "string" }, "exposedPorts": { "type": "object", "additionalProperties": { "type": "object", "properties": {}, "required": [], "additionalProperties": false } } }, "required": [], "additionalProperties": false, "nullable": true }, "os": { "type": "string", "nullable": true }, "architecture": { "type": "string", "nullable": true }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "sourceType": { "type": "string" }, "isUsed": { "type": "boolean" }, "billableDigest": { "type": "string", "nullable": true }, "billableSizeBytes": { "type": "number", "nullable": true }, "billableLayerCount": { "type": "number", "nullable": true }, "hourlyStorageCost": { "type": "string" }, "monthlyStorageCost": { "type": "string" }, "storageBillingStatus": { "type": "string", "nullable": true }, "lastStorageSyncedAt": { "type": "string", "nullable": true }, "createdByUserId": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastUsedAt": { "type": "string", "nullable": true }, "usedByContainers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "id", "projectId", "buildJobId", "name", "tag", "registryRef", "digest", "sizeBytes", "layerCount", "config", "os", "architecture", "labels", "sourceType", "isUsed", "billableDigest", "billableSizeBytes", "billableLayerCount", "hourlyStorageCost", "monthlyStorageCost", "storageBillingStatus", "lastStorageSyncedAt", "createdByUserId", "createdAt", "updatedAt", "lastUsedAt", "usedByContainers" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "id": "string", "projectId": "string", "buildJobId": "string", "name": "string", "tag": "string", "registryRef": "string", "digest": "string", "sizeBytes": 0, "layerCount": 0, "config": { "entrypoint": [ "string" ], "cmd": [ "string" ], "env": [ "string" ], "workingDir": "string", "user": "string", "exposedPorts": null }, "os": "string", "architecture": "string", "labels": null, "sourceType": "string", "isUsed": true, "billableDigest": "string", "billableSizeBytes": 0, "billableLayerCount": 0, "hourlyStorageCost": "string", "monthlyStorageCost": "string", "storageBillingStatus": "string", "lastStorageSyncedAt": "string", "createdByUserId": "string", "createdAt": "string", "updatedAt": "string", "lastUsedAt": "string", "usedByContainers": [ { "id": "string", "name": "string" } ] }, "meta": { "requestId": "string", "timestamp": "string" } }
POSTMove a registry image to another projectDetails +/api/v1/projects/:projectId/registry/images/:imageId/move
Reassigns an existing image to a different target project. Unlike copy, the original image entry is updated in place rather than duplicated.
- Returns a 409 if the image is currently in use by a container.
- Requires admin-level (project:delete) permission on both the source and target projects.
- Dispatches an
image.movedwebhook event scoped to the source project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
imageId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
targetProjectId | string | Yes |
Complete request schema
{
"type": "object",
"properties": {
"targetProjectId": {
"type": "string"
}
},
"required": [
"targetProjectId"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "tag": { "type": "string" }, "registryRef": { "type": "string" } }, "required": [ "id", "projectId", "name", "tag", "registryRef" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "id": "string", "projectId": "string", "name": "string", "tag": "string", "registryRef": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
GETGet the latest vulnerability scan result for an imageDetails +/api/v1/projects/:projectId/registry/images/:imageId/scan
Returns the most recent vulnerability scan for a given image, including its status, a severity summary, and the full list of detected vulnerabilities.
- Status is one of queued, scanning, complete, or failed.
- Severity summary includes critical/high/medium/low/unknown counts.
- Each vulnerability includes package, installed/fixed versions, and severity.
- Returns null if no scan has ever been run for the image.
- Requires read access to the project.
- Returns a 404 if the image itself doesn't exist.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
imageId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "projectImageId": { "type": "string" }, "status": { "type": "string" }, "scannerVersion": { "type": "string", "nullable": true }, "vulnerabilities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "package": { "type": "string" }, "installedVersion": { "type": "string" }, "fixedVersion": { "type": "string" }, "severity": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "reference": { "type": "string" } }, "required": [ "id", "package", "installedVersion", "severity", "title" ], "additionalProperties": false }, "nullable": true }, "summary": { "type": "object", "properties": { "critical": { "type": "number" }, "high": { "type": "number" }, "medium": { "type": "number" }, "low": { "type": "number" }, "unknown": { "type": "number" } }, "required": [ "critical", "high", "medium", "low", "unknown" ], "additionalProperties": false, "nullable": true }, "error": { "type": "string", "nullable": true }, "startedAt": { "type": "string", "nullable": true }, "completedAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string" } }, "required": [ "id", "projectImageId", "status", "scannerVersion", "vulnerabilities", "summary", "error", "startedAt", "completedAt", "createdAt" ], "additionalProperties": false, "nullable": true }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "id": "string", "projectImageId": "string", "status": "string", "scannerVersion": "string", "vulnerabilities": [ { "id": "string", "package": "string", "installedVersion": "string", "fixedVersion": "string", "severity": "string", "title": "string", "description": "string", "reference": "string" } ], "summary": { "critical": 0, "high": 0, "medium": 0, "low": 0, "unknown": 0 }, "error": "string", "startedAt": "string", "completedAt": "string", "createdAt": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
POSTTrigger a new vulnerability scan for an imageDetails +/api/v1/projects/:projectId/registry/images/:imageId/scan/trigger
Queues a new vulnerability scan for the specified image and immediately returns the created scan record with status queued.
- The scan runs asynchronously, progressing through scanning, then complete or failed.
- On successful completion, a per-severity vulnerability summary is recorded and an
image.scan.completedwebhook event is dispatched. - Requires admin-level (project:delete) permission on the project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
imageId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|
Complete request schema
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "projectImageId": { "type": "string" }, "status": { "type": "string" }, "scannerVersion": { "type": "string", "nullable": true }, "vulnerabilities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "package": { "type": "string" }, "installedVersion": { "type": "string" }, "fixedVersion": { "type": "string" }, "severity": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "reference": { "type": "string" } }, "required": [ "id", "package", "installedVersion", "severity", "title" ], "additionalProperties": false }, "nullable": true }, "summary": { "type": "object", "properties": { "critical": { "type": "number" }, "high": { "type": "number" }, "medium": { "type": "number" }, "low": { "type": "number" }, "unknown": { "type": "number" } }, "required": [ "critical", "high", "medium", "low", "unknown" ], "additionalProperties": false, "nullable": true }, "error": { "type": "string", "nullable": true }, "startedAt": { "type": "string", "nullable": true }, "completedAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string" } }, "required": [ "id", "projectImageId", "status", "scannerVersion", "vulnerabilities", "summary", "error", "startedAt", "completedAt", "createdAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "id": "string", "projectImageId": "string", "status": "string", "scannerVersion": "string", "vulnerabilities": [ { "id": "string", "package": "string", "installedVersion": "string", "fixedVersion": "string", "severity": "string", "title": "string", "description": "string", "reference": "string" } ], "summary": { "critical": 0, "high": 0, "medium": 0, "low": 0, "unknown": 0 }, "error": "string", "startedAt": "string", "completedAt": "string", "createdAt": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
GETGet a project's registry configurationDetails +/api/v1/projects/:projectId/registry/settings
Returns the project's registry settings: automatic image cleanup retention, public accessibility, maximum tags retained per image, and whether images are automatically scanned on push.
- If no settings have been configured yet, defaults are returned: 30-day cleanup retention, private access, unlimited tag retention, and scan-on-push disabled.
- Requires read access to the project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "projectId": { "type": "string" }, "autoCleanupDays": { "type": "number" }, "publicAccess": { "type": "boolean" }, "retentionMaxTags": { "type": "number" }, "scanOnPush": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "projectId", "autoCleanupDays", "publicAccess", "retentionMaxTags", "scanOnPush", "createdAt", "updatedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "projectId": "string", "autoCleanupDays": 0, "publicAccess": true, "retentionMaxTags": 0, "scanOnPush": true, "createdAt": "string", "updatedAt": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
PUTUpdate a project's registry configurationDetails +/api/v1/projects/:projectId/registry/settings/update
Updates one or more registry settings for the project: auto-cleanup retention, public access, max tags retained per image, and scan-on-push behavior.
- Auto-cleanup retention is clamped to 0-365 days.
- Max tags retained per image is clamped to 0-1000.
- Only the fields provided in the request are changed; unspecified fields are left as-is.
- Requires admin-level (project:delete) permission on the project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
autoCleanupDays | number | No |
publicAccess | boolean | No |
retentionMaxTags | number | No |
scanOnPush | boolean | No |
Complete request schema
{
"type": "object",
"properties": {
"autoCleanupDays": {
"type": "number"
},
"publicAccess": {
"type": "boolean"
},
"retentionMaxTags": {
"type": "number"
},
"scanOnPush": {
"type": "boolean"
}
},
"required": [],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "projectId": { "type": "string" }, "autoCleanupDays": { "type": "number" }, "publicAccess": { "type": "boolean" }, "retentionMaxTags": { "type": "number" }, "scanOnPush": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "projectId", "autoCleanupDays", "publicAccess", "retentionMaxTags", "scanOnPush", "createdAt", "updatedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "projectId": "string", "autoCleanupDays": 0, "publicAccess": true, "retentionMaxTags": 0, "scanOnPush": true, "createdAt": "string", "updatedAt": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
POSTCreate a registry access token for a projectDetails +/api/v1/projects/:projectId/registry/tokens/create
Generates a new registry access token scoped to push, pull, push_pull, or signed_url usage, optionally restricted to images matching a glob-like pattern and with an optional expiration.
- The raw token value is returned exactly once in the creation response and cannot be retrieved again afterward.
- Requires admin-level (project:delete) permission on the project.
- Intended for use as registry pull/push credentials, e.g. in CI or
docker login.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
label | string | Yes |
type | push | pull | push_pull | signed_url | Yes |
imagePattern | string | No |
expiresInDays | number | No |
Complete request schema
{
"type": "object",
"properties": {
"label": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"push",
"pull",
"push_pull",
"signed_url"
]
},
"imagePattern": {
"type": "string"
},
"expiresInDays": {
"type": "number"
}
},
"required": [
"label",
"type"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "imagePattern": { "type": "string" }, "tokenPrefix": { "type": "string" }, "token": { "type": "string" }, "expiresAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string" } }, "required": [ "id", "label", "type", "imagePattern", "tokenPrefix", "token", "expiresAt", "createdAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "id": "string", "label": "string", "type": "string", "imagePattern": "string", "tokenPrefix": "string", "token": "string", "expiresAt": "string", "createdAt": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
GETList registry access tokens for a projectDetails +/api/v1/projects/:projectId/registry/tokens
Returns a paginated list of registry access tokens created for the project, ordered by creation date descending.
- Only metadata is returned (label, type, image pattern, prefix, expiry, revocation status, last-used timestamp); the raw token secret is never included.
- Requires read access to the project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
page | query | No | number | — |
pageSize | query | No | number | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "tokens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "imagePattern": { "type": "string" }, "tokenPrefix": { "type": "string" }, "expiresAt": { "type": "string", "nullable": true }, "lastUsedAt": { "type": "string", "nullable": true }, "createdByUserId": { "type": "string", "nullable": true }, "isRevoked": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "projectId", "label", "type", "imagePattern", "tokenPrefix", "expiresAt", "lastUsedAt", "createdByUserId", "isRevoked", "createdAt", "updatedAt" ], "additionalProperties": false } }, "total": { "type": "number" } }, "required": [ "tokens", "total" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "tokens": [ { "id": "string", "projectId": "string", "label": "string", "type": "string", "imagePattern": "string", "tokenPrefix": "string", "expiresAt": "string", "lastUsedAt": "string", "createdByUserId": "string", "isRevoked": true, "createdAt": "string", "updatedAt": "string" } ], "total": 0 }, "meta": { "requestId": "string", "timestamp": "string" } }
POSTRevoke a registry access tokenDetails +/api/v1/projects/:projectId/registry/tokens/:tokenId/delete
Marks a registry access token as revoked so it can no longer be used to authenticate registry push/pull requests.
- The token remains listed but is rejected on any subsequent use; revocation is not reversible through this API.
- Returns a 404 if the token doesn't belong to the specified project.
- Requires admin-level (project:delete) permission on the project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
tokenId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|
Complete request schema
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "const": true, "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "success": true }, "meta": { "requestId": "string", "timestamp": "string" } }
POSTCreate a registry event webhookDetails +/api/v1/projects/:projectId/registry/webhooks/create
Registers a webhook URL that will receive POST callbacks for selected registry events (image pushed, deleted, moved, copied, or scan completed).
- If a secret is provided, outgoing deliveries are signed with an HMAC-SHA256 signature sent in the
X-Hubfly space-Signatureheader so the receiver can verify authenticity. - The webhook is active by default.
- Requires admin-level (project:delete) permission on the project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
label | string | Yes |
url | string | Yes |
secret | string | No |
events | string[] | Yes |
Complete request schema
{
"type": "object",
"properties": {
"label": {
"type": "string"
},
"url": {
"type": "string"
},
"secret": {
"type": "string"
},
"events": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"label",
"url",
"events"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "label": { "type": "string" }, "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" }, "lastTriggeredAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "projectId", "label", "url", "events", "active", "lastTriggeredAt", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "webhook" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "webhook": { "id": "string", "projectId": "string", "label": "string", "url": "string", "events": [ "string" ], "active": true, "lastTriggeredAt": "string", "createdAt": "string", "updatedAt": "string" } }, "meta": { "requestId": "string", "timestamp": "string" } }
GETList registry webhooks configured for a projectDetails +/api/v1/projects/:projectId/registry/webhooks
Returns all registry webhooks configured for the project, ordered by creation date descending, including their target URL, subscribed events, active status, and last-triggered timestamp.
- Requires read access to the project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "webhooks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "label": { "type": "string" }, "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" }, "lastTriggeredAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "projectId", "label", "url", "events", "active", "lastTriggeredAt", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "webhooks" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "webhooks": [ { "id": "string", "projectId": "string", "label": "string", "url": "string", "events": [ "string" ], "active": true, "lastTriggeredAt": "string", "createdAt": "string", "updatedAt": "string" } ] }, "meta": { "requestId": "string", "timestamp": "string" } }
DELETEDelete a registry webhookDetails +/api/v1/projects/:projectId/registry/webhooks/:webhookId/delete
Permanently deletes a registry webhook along with its delivery history.
- Requires admin-level (project:delete) permission on the project.
- No error is raised if the webhook does not exist.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
webhookId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "success": true }, "meta": { "requestId": "string", "timestamp": "string" } }
GETList recent delivery attempts for a webhookDetails +/api/v1/projects/:projectId/registry/webhooks/:webhookId/deliveries
Returns up to the 50 most recent delivery attempts for a given webhook, ordered by creation date descending, including the triggering event, status, HTTP response code/body, and any delivery error.
- Status is one of pending, delivered, or failed.
- Useful for debugging why a webhook receiver isn't getting events or is rejecting them.
- Requires read access to the project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
webhookId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "deliveries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "webhookId": { "type": "string" }, "event": { "type": "string" }, "status": { "type": "string" }, "responseCode": { "type": "number", "nullable": true }, "responseBody": { "type": "string", "nullable": true }, "error": { "type": "string", "nullable": true }, "attemptedAt": { "type": "string", "nullable": true }, "completedAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string" } }, "required": [ "id", "webhookId", "event", "status", "responseCode", "responseBody", "error", "attemptedAt", "completedAt", "createdAt" ], "additionalProperties": false } } }, "required": [ "deliveries" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "deliveries": [ { "id": "string", "webhookId": "string", "event": "string", "status": "string", "responseCode": 0, "responseBody": "string", "error": "string", "attemptedAt": "string", "completedAt": "string", "createdAt": "string" } ] }, "meta": { "requestId": "string", "timestamp": "string" } }
PUTUpdate a registry webhook's configurationDetails +/api/v1/projects/:projectId/registry/webhooks/:webhookId/update
Updates one or more fields of an existing webhook: label, target URL, signing secret, subscribed events, or active status.
- Unspecified fields are left unchanged.
- Returns a 404 if the webhook is not found under the given project.
- Requires admin-level (project:delete) permission on the project.
- Setting
activeto false stops further event deliveries without deleting the webhook or its history.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
webhookId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
label | string | No |
url | string | No |
secret | string | No |
events | string[] | No |
active | boolean | No |
Complete request schema
{
"type": "object",
"properties": {
"label": {
"type": "string"
},
"url": {
"type": "string"
},
"secret": {
"type": "string"
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"active": {
"type": "boolean"
}
},
"required": [],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "label": { "type": "string" }, "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" }, "lastTriggeredAt": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "projectId", "label", "url", "events", "active", "lastTriggeredAt", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "webhook" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "webhook": { "id": "string", "projectId": "string", "label": "string", "url": "string", "events": [ "string" ], "active": true, "lastTriggeredAt": "string", "createdAt": "string", "updatedAt": "string" } }, "meta": { "requestId": "string", "timestamp": "string" } }
POSTStore credentials for an external image registryDetails +/api/v1/projects/:projectId/registry-credentials/create
Stores a label, registry URL, optional username, and password/token for authenticating against an external container registry (e.g. Docker Hub, ECR, GHCR), so the project can pull private base images during builds or deploys.
- The password is encrypted at rest and is never returned in responses.
- Registry URL and password are required.
- Requires
container:createpermission on the project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
label | string | Yes |
registryUrl | string | Yes |
username | string | No |
password | string | Yes |
Complete request schema
{
"type": "object",
"properties": {
"label": {
"type": "string"
},
"registryUrl": {
"type": "string"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
}
},
"required": [
"label",
"registryUrl",
"password"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "credential": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "registryUrl": { "type": "string" }, "username": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastUsedAt": { "type": "string", "nullable": true } }, "required": [ "id", "label", "registryUrl", "username", "createdAt", "updatedAt", "lastUsedAt" ], "additionalProperties": false } }, "required": [ "credential" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "credential": { "id": "string", "label": "string", "registryUrl": "string", "username": "string", "createdAt": "string", "updatedAt": "string", "lastUsedAt": "string" } }, "meta": { "requestId": "string", "timestamp": "string" } }
GETList stored external registry credentialsDetails +/api/v1/projects/:projectId/registry-credentials
Returns the external registry credentials saved for the project (label, registry URL, username, and timestamps), ordered by creation date.
- The encrypted password is never exposed in the response.
- Requires
container:createpermission on the project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "credentials": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "registryUrl": { "type": "string" }, "username": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "lastUsedAt": { "type": "string", "nullable": true } }, "required": [ "id", "label", "registryUrl", "username", "createdAt", "updatedAt", "lastUsedAt" ], "additionalProperties": false } } }, "required": [ "credentials" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "credentials": [ { "id": "string", "label": "string", "registryUrl": "string", "username": "string", "createdAt": "string", "updatedAt": "string", "lastUsedAt": "string" } ] }, "meta": { "requestId": "string", "timestamp": "string" } }
DELETEDelete a stored external registry credentialDetails +/api/v1/projects/:projectId/registry-credentials/:credentialId/delete
Permanently deletes a stored external registry credential belonging to the project.
- Returns a 404 if it doesn't belong to the project.
- Requires
container:deletepermission on the project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
credentialId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "success": true }, "meta": { "requestId": "string", "timestamp": "string" } }
POSTCreate a deployment webhook for a projectDetails +/api/v1/projects/:projectId/webhooks/create
Creates a webhook endpoint that can trigger container deployments (pull/create/update/restart/rollback/delete) for a project, either scoped to a specific container or project-wide.
- Supports basic/standard auth modes, which use a bearer token, and secure mode, which uses an HMAC signing secret requiring signed requests.
- The raw token or secret is returned only once, in the creation response, and cannot be retrieved again afterward.
- Only the token's prefix is retained for basic/standard mode after creation.
- The signing secret for secure mode is encrypted at rest.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
containerId | string | No |
name | string | Yes |
description | string | No |
mode | basic | standard | secure | Yes |
allowedActions | string[] | Yes |
ipAllowlist | string[] | No |
Complete request schema
{
"type": "object",
"properties": {
"containerId": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"mode": {
"type": "string",
"enum": [
"basic",
"standard",
"secure"
]
},
"allowedActions": {
"type": "array",
"items": {
"type": "string"
}
},
"ipAllowlist": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"mode",
"allowedActions"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "containerId": { "type": "string", "nullable": true }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "mode": { "type": "string", "enum": [ "basic", "standard", "secure" ] }, "tokenPrefix": { "type": "string", "nullable": true }, "allowedActions": { "type": "array", "items": { "type": "string" } }, "ipAllowlist": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isActive": { "type": "boolean" }, "lastTriggered": { "type": "string", "nullable": true }, "triggerCount": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "projectId", "containerId", "name", "description", "mode", "tokenPrefix", "allowedActions", "ipAllowlist", "isActive", "lastTriggered", "triggerCount", "createdAt", "updatedAt" ], "additionalProperties": false }, "rawTokenOrSecret": { "type": "string" } }, "required": [ "webhook", "rawTokenOrSecret" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "webhook": { "id": "string", "projectId": "string", "containerId": "string", "name": "string", "description": "string", "mode": "basic", "tokenPrefix": "string", "allowedActions": [ "string" ], "ipAllowlist": [ "string" ], "isActive": true, "lastTriggered": "string", "triggerCount": 0, "createdAt": "string", "updatedAt": "string" }, "rawTokenOrSecret": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
GETList deployment webhooks for a projectDetails +/api/v1/projects/:projectId/webhooks
Returns all configured deployment webhooks for a project, including their mode, allowed actions, IP allowlist, activity status, and trigger stats.
- Never returns the underlying token or secret value.
- Requires project:read permission; allowed while hibernating.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "containerId": { "type": "string", "nullable": true }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "mode": { "type": "string", "enum": [ "basic", "standard", "secure" ] }, "tokenPrefix": { "type": "string", "nullable": true }, "allowedActions": { "type": "array", "items": { "type": "string" } }, "ipAllowlist": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isActive": { "type": "boolean" }, "lastTriggered": { "type": "string", "nullable": true }, "triggerCount": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "projectId", "containerId", "name", "description", "mode", "tokenPrefix", "allowedActions", "ipAllowlist", "isActive", "lastTriggered", "triggerCount", "createdAt", "updatedAt" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": [ { "id": "string", "projectId": "string", "containerId": "string", "name": "string", "description": "string", "mode": "basic", "tokenPrefix": "string", "allowedActions": [ "string" ], "ipAllowlist": [ "string" ], "isActive": true, "lastTriggered": "string", "triggerCount": 0, "createdAt": "string", "updatedAt": "string" } ], "meta": { "requestId": "string", "timestamp": "string" } }
DELETEDelete a deployment webhookDetails +/api/v1/projects/:projectId/webhooks/:webhookId
Permanently deletes a webhook from a project so its token or secret can no longer be used to trigger deployments.
- Requires container:update permission on the project.
- Allowed while hibernating.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
webhookId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "success": true }, "meta": { "requestId": "string", "timestamp": "string" } }