NNO Docs
API ReferenceRegistry

NNO Registry Service API

Platform catalog, stacks, resources, DNS records, and feature management.

List platforms (cursor-paginated)

GET
/api/v1/platforms

Query Parameters

limit?string
cursor?string

Response Body

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms"
{
  "data": [
    {
      "id": "string",
      "name": "string",
      "slug": "string",
      "status": "string",
      "tier": "string",
      "cfAccountId": "string",
      "repoName": "string",
      "stripeCustomerId": "string",
      "ownerUserId": "string",
      "cancelledAt": "string",
      "cancellationReason": "string",
      "suspendedAt": "string",
      "suspensionReason": "string",
      "trialEndsAt": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": "string"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string",
    "total": 0
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Create a new platform

POST
/api/v1/platforms

Request Body

application/json

name*string
Length1 <= length
slug*string
Match^[a-z0-9-]+$
Length1 <= length
tier?string
Default"starter"
Value in"starter" | "growth" | "scale"
cfAccountId?string
repoName?string

Response Body

application/json

application/json

application/json

curl -X POST "https://registry.svc.nno.app/api/v1/platforms" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "slug": "string"  }'
{
  "id": "string",
  "name": "string",
  "slug": "string",
  "status": "string",
  "tier": "string",
  "cfAccountId": "string",
  "repoName": "string",
  "stripeCustomerId": "string",
  "ownerUserId": "string",
  "cancelledAt": "string",
  "cancellationReason": "string",
  "suspendedAt": "string",
  "suspensionReason": "string",
  "trialEndsAt": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Get a platform by ID

GET
/api/v1/platforms/{platformId}

Path Parameters

platformId*string

Response Body

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string"
{
  "id": "string",
  "name": "string",
  "slug": "string",
  "status": "string",
  "tier": "string",
  "cfAccountId": "string",
  "repoName": "string",
  "stripeCustomerId": "string",
  "ownerUserId": "string",
  "cancelledAt": "string",
  "cancellationReason": "string",
  "suspendedAt": "string",
  "suspensionReason": "string",
  "trialEndsAt": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Update a platform

PATCH
/api/v1/platforms/{platformId}

Path Parameters

platformId*string

Request Body

application/json

name?string
Length1 <= length
tier?string
Value in"starter" | "growth" | "scale"
status?string
Value in"active" | "suspended" | "deleted"
cfAccountId?string
repoName?string

Response Body

application/json

application/json

application/json

curl -X PATCH "https://registry.svc.nno.app/api/v1/platforms/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "name": "string",
  "slug": "string",
  "status": "string",
  "tier": "string",
  "cfAccountId": "string",
  "repoName": "string",
  "stripeCustomerId": "string",
  "ownerUserId": "string",
  "cancelledAt": "string",
  "cancellationReason": "string",
  "suspendedAt": "string",
  "suspensionReason": "string",
  "trialEndsAt": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Soft-delete a platform

DELETE
/api/v1/platforms/{platformId}

Path Parameters

platformId*string

Response Body

application/json

application/json

curl -X DELETE "https://registry.svc.nno.app/api/v1/platforms/string"
{
  "success": true
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Suspend a platform

POST
/api/v1/platforms/{platformId}/suspend

Path Parameters

platformId*string

Request Body

application/json

reason?string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://registry.svc.nno.app/api/v1/platforms/string/suspend" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "name": "string",
  "slug": "string",
  "status": "string",
  "tier": "string",
  "cfAccountId": "string",
  "repoName": "string",
  "stripeCustomerId": "string",
  "ownerUserId": "string",
  "cancelledAt": "string",
  "cancellationReason": "string",
  "suspendedAt": "string",
  "suspensionReason": "string",
  "trialEndsAt": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Restore a suspended platform

POST
/api/v1/platforms/{platformId}/restore

Path Parameters

platformId*string

Request Body

application/json

reason?string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://registry.svc.nno.app/api/v1/platforms/string/restore" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "name": "string",
  "slug": "string",
  "status": "string",
  "tier": "string",
  "cfAccountId": "string",
  "repoName": "string",
  "stripeCustomerId": "string",
  "ownerUserId": "string",
  "cancelledAt": "string",
  "cancellationReason": "string",
  "suspendedAt": "string",
  "suspensionReason": "string",
  "trialEndsAt": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Cancel a platform

POST
/api/v1/platforms/{platformId}/cancel

Path Parameters

platformId*string

Request Body

application/json

reason?string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://registry.svc.nno.app/api/v1/platforms/string/cancel" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "name": "string",
  "slug": "string",
  "status": "string",
  "tier": "string",
  "cfAccountId": "string",
  "repoName": "string",
  "stripeCustomerId": "string",
  "ownerUserId": "string",
  "cancelledAt": "string",
  "cancellationReason": "string",
  "suspendedAt": "string",
  "suspensionReason": "string",
  "trialEndsAt": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Hard-delete a platform and deprovision

POST
/api/v1/platforms/{platformId}/delete

Path Parameters

platformId*string

Request Body

application/json

reason?string

Response Body

application/json

application/json

application/json

curl -X POST "https://registry.svc.nno.app/api/v1/platforms/string/delete" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "name": "string",
  "slug": "string",
  "status": "string",
  "tier": "string",
  "cfAccountId": "string",
  "repoName": "string",
  "stripeCustomerId": "string",
  "ownerUserId": "string",
  "cancelledAt": "string",
  "cancellationReason": "string",
  "suspendedAt": "string",
  "suspensionReason": "string",
  "trialEndsAt": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

List lifecycle events for a platform

GET
/api/v1/platforms/{platformId}/lifecycle

Path Parameters

platformId*string

Query Parameters

limit?string
cursor?string

Response Body

application/json

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/lifecycle"
{
  "data": [
    {
      "id": "string",
      "platformId": "string",
      "fromStatus": "string",
      "toStatus": "string",
      "triggeredBy": "string",
      "triggerType": "string",
      "reason": "string",
      "metadata": null,
      "createdAt": "string"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string",
    "total": 0
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Lookup resource by CF name

GET
/api/v1/resources/lookup

Query Parameters

cfName?string

Response Body

application/json

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/resources/lookup"
{
  "id": "string",
  "platformId": "string",
  "entityId": "string",
  "resourceType": "string",
  "serviceName": "string",
  "environment": "string",
  "cfName": "string",
  "cfId": "string",
  "cfUrl": "string",
  "status": "string",
  "provisionJobId": "string",
  "config": null,
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

List resources for a platform

GET
/api/v1/resources/platforms/{platformId}/resources

Path Parameters

platformId*string

Query Parameters

limit?string
cursor?string

Response Body

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/resources/platforms/string/resources"
{
  "data": [
    {
      "id": "string",
      "platformId": "string",
      "entityId": "string",
      "resourceType": "string",
      "serviceName": "string",
      "environment": "string",
      "cfName": "string",
      "cfId": "string",
      "cfUrl": "string",
      "status": "string",
      "provisionJobId": "string",
      "config": null,
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": "string"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string",
    "total": 0
  }
}

List resources for an entity

GET
/api/v1/resources/platforms/{platformId}/entities/{entityId}/resources

Path Parameters

platformId*string
entityId*string

Query Parameters

limit?string
cursor?string

Response Body

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/resources/platforms/string/entities/string/resources"
{
  "data": [
    {
      "id": "string",
      "platformId": "string",
      "entityId": "string",
      "resourceType": "string",
      "serviceName": "string",
      "environment": "string",
      "cfName": "string",
      "cfId": "string",
      "cfUrl": "string",
      "status": "string",
      "provisionJobId": "string",
      "config": null,
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": "string"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string",
    "total": 0
  }
}

Register a resource

POST
/api/v1/resources/platforms/{platformId}/entities/{entityId}/resources

Path Parameters

platformId*string
entityId*string

Request Body

application/json

stackId*string
Length1 <= length
resourceType*string
Value in"worker" | "pages" | "d1" | "r2" | "kv" | "queue"
serviceName*string
Length1 <= length
environment*string
Value in"dev" | "stg" | "prod"
cfName*string
Length1 <= length
cfId?string
cfUrl?string
Formaturi
provisionJobId?string
config?

Response Body

application/json

application/json

application/json

curl -X POST "https://registry.svc.nno.app/api/v1/resources/platforms/string/entities/string/resources" \  -H "Content-Type: application/json" \  -d '{    "stackId": "string",    "resourceType": "worker",    "serviceName": "string",    "environment": "dev",    "cfName": "string"  }'
{
  "id": "string",
  "platformId": "string",
  "entityId": "string",
  "resourceType": "string",
  "serviceName": "string",
  "environment": "string",
  "cfName": "string",
  "cfId": "string",
  "cfUrl": "string",
  "status": "string",
  "provisionJobId": "string",
  "config": null,
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Get a resource by ID

GET
/api/v1/resources/platforms/{platformId}/resources/{resourceId}

Path Parameters

platformId*string
resourceId*string

Response Body

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/resources/platforms/string/resources/string"
{
  "id": "string",
  "platformId": "string",
  "entityId": "string",
  "resourceType": "string",
  "serviceName": "string",
  "environment": "string",
  "cfName": "string",
  "cfId": "string",
  "cfUrl": "string",
  "status": "string",
  "provisionJobId": "string",
  "config": null,
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Update a resource

PATCH
/api/v1/resources/platforms/{platformId}/resources/{resourceId}

Path Parameters

platformId*string
resourceId*string

Request Body

application/json

status?string
Value in"pending" | "provisioning" | "active" | "failed" | "deleted"
cfId?string
cfUrl?string
Formaturi
config?
provisionJobId?string

Response Body

application/json

application/json

application/json

curl -X PATCH "https://registry.svc.nno.app/api/v1/resources/platforms/string/resources/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "platformId": "string",
  "entityId": "string",
  "resourceType": "string",
  "serviceName": "string",
  "environment": "string",
  "cfName": "string",
  "cfId": "string",
  "cfUrl": "string",
  "status": "string",
  "provisionJobId": "string",
  "config": null,
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Soft-delete a resource

DELETE
/api/v1/resources/platforms/{platformId}/resources/{resourceId}

Path Parameters

platformId*string
resourceId*string

Response Body

application/json

application/json

curl -X DELETE "https://registry.svc.nno.app/api/v1/resources/platforms/string/resources/string"
{
  "success": true
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

List entities for a platform

GET
/api/v1/platforms/{platformId}/entities

Path Parameters

platformId*string

Query Parameters

type?string
limit?string
cursor?string

Response Body

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/entities"
{
  "data": [
    {
      "id": "string",
      "platformId": "string",
      "parentId": "string",
      "type": "string",
      "name": "string",
      "slug": "string",
      "status": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": "string"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string",
    "total": 0
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Create an entity

POST
/api/v1/platforms/{platformId}/entities

Path Parameters

platformId*string

Request Body

application/json

name*string
Length1 <= length
slug*string
Match^[a-z0-9-]+$
Length1 <= length
type*string
Value in"tenant" | "subtenant"
parentId?string|null

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://registry.svc.nno.app/api/v1/platforms/string/entities" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "slug": "string",    "type": "tenant"  }'
{
  "id": "string",
  "platformId": "string",
  "parentId": "string",
  "type": "string",
  "name": "string",
  "slug": "string",
  "status": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Get an entity by ID

GET
/api/v1/platforms/{platformId}/entities/{entityId}

Path Parameters

platformId*string
entityId*string

Response Body

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/entities/string"
{
  "id": "string",
  "platformId": "string",
  "parentId": "string",
  "type": "string",
  "name": "string",
  "slug": "string",
  "status": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Update an entity

PATCH
/api/v1/platforms/{platformId}/entities/{entityId}

Path Parameters

platformId*string
entityId*string

Request Body

application/json

name?string
Length1 <= length
status?string
Value in"active" | "suspended" | "deleted"

Response Body

application/json

application/json

application/json

curl -X PATCH "https://registry.svc.nno.app/api/v1/platforms/string/entities/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "platformId": "string",
  "parentId": "string",
  "type": "string",
  "name": "string",
  "slug": "string",
  "status": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Soft-delete an entity

DELETE
/api/v1/platforms/{platformId}/entities/{entityId}

Path Parameters

platformId*string
entityId*string

Response Body

application/json

application/json

curl -X DELETE "https://registry.svc.nno.app/api/v1/platforms/string/entities/string"
{
  "success": true
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Get entity ancestors (recursive)

GET
/api/v1/platforms/{platformId}/entities/{entityId}/ancestors

Path Parameters

platformId*string
entityId*string

Response Body

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/entities/string/ancestors"
{
  "data": [
    null
  ]
}

Get entity descendants (recursive)

GET
/api/v1/platforms/{platformId}/entities/{entityId}/descendants

Path Parameters

platformId*string
entityId*string

Response Body

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/entities/string/descendants"
{
  "data": [
    null
  ]
}

Lookup resource by CF name

GET
/api/v1/lookup

Query Parameters

cfName?string

Response Body

application/json

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/lookup"
{
  "id": "string",
  "platformId": "string",
  "entityId": "string",
  "resourceType": "string",
  "serviceName": "string",
  "environment": "string",
  "cfName": "string",
  "cfId": "string",
  "cfUrl": "string",
  "status": "string",
  "provisionJobId": "string",
  "config": null,
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

List resources for a platform

GET
/api/v1/platforms/{platformId}/resources

Path Parameters

platformId*string

Query Parameters

limit?string
cursor?string

Response Body

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/resources"
{
  "data": [
    {
      "id": "string",
      "platformId": "string",
      "entityId": "string",
      "resourceType": "string",
      "serviceName": "string",
      "environment": "string",
      "cfName": "string",
      "cfId": "string",
      "cfUrl": "string",
      "status": "string",
      "provisionJobId": "string",
      "config": null,
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": "string"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string",
    "total": 0
  }
}

List resources for an entity

GET
/api/v1/platforms/{platformId}/entities/{entityId}/resources

Path Parameters

platformId*string
entityId*string

Query Parameters

limit?string
cursor?string

Response Body

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/entities/string/resources"
{
  "data": [
    {
      "id": "string",
      "platformId": "string",
      "entityId": "string",
      "resourceType": "string",
      "serviceName": "string",
      "environment": "string",
      "cfName": "string",
      "cfId": "string",
      "cfUrl": "string",
      "status": "string",
      "provisionJobId": "string",
      "config": null,
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": "string"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string",
    "total": 0
  }
}

Register a resource

POST
/api/v1/platforms/{platformId}/entities/{entityId}/resources

Path Parameters

platformId*string
entityId*string

Request Body

application/json

stackId*string
Length1 <= length
resourceType*string
Value in"worker" | "pages" | "d1" | "r2" | "kv" | "queue"
serviceName*string
Length1 <= length
environment*string
Value in"dev" | "stg" | "prod"
cfName*string
Length1 <= length
cfId?string
cfUrl?string
Formaturi
provisionJobId?string
config?

Response Body

application/json

application/json

application/json

curl -X POST "https://registry.svc.nno.app/api/v1/platforms/string/entities/string/resources" \  -H "Content-Type: application/json" \  -d '{    "stackId": "string",    "resourceType": "worker",    "serviceName": "string",    "environment": "dev",    "cfName": "string"  }'
{
  "id": "string",
  "platformId": "string",
  "entityId": "string",
  "resourceType": "string",
  "serviceName": "string",
  "environment": "string",
  "cfName": "string",
  "cfId": "string",
  "cfUrl": "string",
  "status": "string",
  "provisionJobId": "string",
  "config": null,
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Get a resource by ID

GET
/api/v1/platforms/{platformId}/resources/{resourceId}

Path Parameters

platformId*string
resourceId*string

Response Body

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/resources/string"
{
  "id": "string",
  "platformId": "string",
  "entityId": "string",
  "resourceType": "string",
  "serviceName": "string",
  "environment": "string",
  "cfName": "string",
  "cfId": "string",
  "cfUrl": "string",
  "status": "string",
  "provisionJobId": "string",
  "config": null,
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Update a resource

PATCH
/api/v1/platforms/{platformId}/resources/{resourceId}

Path Parameters

platformId*string
resourceId*string

Request Body

application/json

status?string
Value in"pending" | "provisioning" | "active" | "failed" | "deleted"
cfId?string
cfUrl?string
Formaturi
config?
provisionJobId?string

Response Body

application/json

application/json

application/json

curl -X PATCH "https://registry.svc.nno.app/api/v1/platforms/string/resources/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "platformId": "string",
  "entityId": "string",
  "resourceType": "string",
  "serviceName": "string",
  "environment": "string",
  "cfName": "string",
  "cfId": "string",
  "cfUrl": "string",
  "status": "string",
  "provisionJobId": "string",
  "config": null,
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Soft-delete a resource

DELETE
/api/v1/platforms/{platformId}/resources/{resourceId}

Path Parameters

platformId*string
resourceId*string

Response Body

application/json

application/json

curl -X DELETE "https://registry.svc.nno.app/api/v1/platforms/string/resources/string"
{
  "success": true
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

List feature activations for an entity

GET
/api/v1/platforms/{platformId}/entities/{entityId}/features

Path Parameters

platformId*string
entityId*string

Query Parameters

limit?string
cursor?string

Response Body

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/entities/string/features"
{
  "data": [
    {
      "id": "string",
      "platformId": "string",
      "entityId": "string",
      "featureId": "string",
      "featureVersion": "string",
      "environment": "string",
      "status": "string",
      "activatedAt": "string",
      "deactivatedAt": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string",
    "total": 0
  }
}

Activate a feature for an entity

POST
/api/v1/platforms/{platformId}/entities/{entityId}/features/activate

Path Parameters

platformId*string
entityId*string

Request Body

application/json

featureId*string
Length1 <= length
version*string
Length1 <= length
environment*string
Value in"dev" | "stg" | "prod"

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://registry.svc.nno.app/api/v1/platforms/string/entities/string/features/activate" \  -H "Content-Type: application/json" \  -d '{    "featureId": "string",    "version": "string",    "environment": "dev"  }'
{
  "activationId": "string",
  "featureId": "string",
  "status": "string",
  "provisionJobId": "string",
  "estimatedDurationSeconds": 0
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "activationId": "string",
  "featureId": "string",
  "status": "string",
  "provisionJobId": "string",
  "estimatedDurationSeconds": 0
}

Deactivate a feature for an entity

POST
/api/v1/platforms/{platformId}/entities/{entityId}/features/deactivate

Path Parameters

platformId*string
entityId*string

Request Body

application/json

featureId*string
Length1 <= length
environment*string
Value in"dev" | "stg" | "prod"

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://registry.svc.nno.app/api/v1/platforms/string/entities/string/features/deactivate" \  -H "Content-Type: application/json" \  -d '{    "featureId": "string",    "environment": "dev"  }'
{
  "featureId": "string",
  "status": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Get a feature activation by ID

GET
/api/v1/platforms/{platformId}/entities/{entityId}/features/{featureId}

Path Parameters

platformId*string
entityId*string
featureId*string

Query Parameters

env?string

Response Body

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/entities/string/features/string"
{
  "id": "string",
  "platformId": "string",
  "entityId": "string",
  "featureId": "string",
  "featureVersion": "string",
  "environment": "string",
  "status": "string",
  "activatedAt": "string",
  "deactivatedAt": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Get the feature manifest for an entity

GET
/api/v1/platforms/{platformId}/entities/{entityId}/manifest

Path Parameters

platformId*string
entityId*string

Query Parameters

env?string

Response Body

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/entities/string/manifest"
{
  "platformId": "string",
  "entityId": "string",
  "environment": "string",
  "features": [
    {
      "id": "string",
      "version": "string",
      "package": "string",
      "serviceUrl": "string",
      "status": "string"
    }
  ],
  "generatedAt": "string"
}

List secrets for a resource

GET
/api/v1/platforms/{platformId}/resources/{resourceId}/secrets

Path Parameters

platformId*string
resourceId*string

Response Body

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/resources/string/secrets"
{
  "data": [
    {
      "id": "string",
      "resourceId": "string",
      "secretName": "string",
      "status": "string",
      "lastSetAt": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Mark or update a secret status

POST
/api/v1/platforms/{platformId}/resources/{resourceId}/secrets/{secretName}

Path Parameters

platformId*string
resourceId*string
secretName*string

Request Body

application/json

status*string
Value in"missing" | "set" | "rotated" | "error"

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://registry.svc.nno.app/api/v1/platforms/string/resources/string/secrets/string" \  -H "Content-Type: application/json" \  -d '{    "status": "missing"  }'
{
  "id": "string",
  "resourceId": "string",
  "secretName": "string",
  "status": "string",
  "lastSetAt": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "id": "string",
  "resourceId": "string",
  "secretName": "string",
  "status": "string",
  "lastSetAt": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

List builds for a platform

GET
/api/v1/platforms/{platformId}/builds

Path Parameters

platformId*string

Response Body

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/builds"
{
  "data": [
    {
      "id": "string",
      "platformId": "string",
      "environment": "string",
      "repoName": "string",
      "lastCommitSha": "string",
      "cfDeploymentId": "string",
      "buildStatus": "string",
      "buildUrl": "string",
      "triggeredBy": "string",
      "triggeredAt": "string",
      "completedAt": "string",
      "updatedAt": "string"
    }
  ]
}

Get the latest build for a platform

GET
/api/v1/platforms/{platformId}/builds/latest

Path Parameters

platformId*string

Query Parameters

env?string

Response Body

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/builds/latest"
{
  "id": "string",
  "platformId": "string",
  "environment": "string",
  "repoName": "string",
  "lastCommitSha": "string",
  "cfDeploymentId": "string",
  "buildStatus": "string",
  "buildUrl": "string",
  "triggeredBy": "string",
  "triggeredAt": "string",
  "completedAt": "string",
  "updatedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Update a build state

PATCH
/api/v1/platforms/{platformId}/builds/{buildId}

Path Parameters

platformId*string
buildId*string

Request Body

application/json

buildStatus?string
Value in"unknown" | "building" | "success" | "failed"
lastCommitSha?string
cfDeploymentId?string
buildUrl?string
Formaturi
triggeredBy?string
Value in"feature_activation" | "manual" | "push"
triggeredAt?integer
completedAt?integer
repoName?string

Response Body

application/json

application/json

application/json

curl -X PATCH "https://registry.svc.nno.app/api/v1/platforms/string/builds/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "platformId": "string",
  "environment": "string",
  "repoName": "string",
  "lastCommitSha": "string",
  "cfDeploymentId": "string",
  "buildStatus": "string",
  "buildUrl": "string",
  "triggeredBy": "string",
  "triggeredAt": "string",
  "completedAt": "string",
  "updatedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

List audit log entries for a platform

GET
/api/v1/platforms/{platformId}/audit

Path Parameters

platformId*string

Query Parameters

limit?string
cursor?string
action?string
entity?string

Response Body

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/audit"
{
  "data": [
    {
      "id": "string",
      "platformId": "string",
      "actorId": "string",
      "actorType": "string",
      "action": "string",
      "entityType": "string",
      "entityId": "string",
      "before": null,
      "after": null,
      "metadata": null,
      "createdAt": "string"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string",
    "total": 0
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

List audit log entries across all platforms

GET
/api/v1/audit

Query Parameters

limit?string
cursor?string
platformId?string
actorId?string
eventType?string
from?string
to?string

Response Body

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/audit"
{
  "data": [
    {
      "id": "string",
      "platformId": "string",
      "actorId": "string",
      "actorType": "string",
      "action": "string",
      "entityType": "string",
      "entityId": "string",
      "before": null,
      "after": null,
      "metadata": null,
      "createdAt": "string"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string",
    "total": 0
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

List workspace stacks for a platform

GET
/api/v1/platforms/{platformId}/stacks

Path Parameters

platformId*string

Query Parameters

limit?string
cursor?string
tenantId?string

Response Body

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/stacks"
{
  "data": [
    {
      "id": "string",
      "tenantId": "string",
      "platformId": "string",
      "name": "string",
      "isDefault": true,
      "templateId": "string",
      "repoName": "string",
      "status": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "cursor": "string"
}

Create a workspace stack

POST
/api/v1/platforms/{platformId}/stacks

Path Parameters

platformId*string

Request Body

application/json

tenantId*string
Length1 <= length
name*string
Length1 <= length
isDefault?boolean
Defaultfalse
templateId?string
Length1 <= length
repoName?string
Length1 <= length

Response Body

application/json

application/json

curl -X POST "https://registry.svc.nno.app/api/v1/platforms/string/stacks" \  -H "Content-Type: application/json" \  -d '{    "tenantId": "string",    "name": "string"  }'
{
  "id": "string",
  "name": "string",
  "status": "string",
  "isDefault": true,
  "createdAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Get a workspace stack by ID

GET
/api/v1/platforms/{platformId}/stacks/{stackId}

Path Parameters

platformId*string
stackId*string

Response Body

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/stacks/string"
{
  "id": "string",
  "tenantId": "string",
  "platformId": "string",
  "name": "string",
  "isDefault": true,
  "templateId": "string",
  "repoName": "string",
  "status": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

List DNS records for a stack

GET
/api/v1/platforms/{platformId}/stacks/{stackId}/dns

Path Parameters

platformId*string
stackId*string

Query Parameters

limit?string
cursor?string

Response Body

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/stacks/string/dns"
{
  "data": [
    {
      "id": "string",
      "platformId": "string",
      "stackId": "string",
      "hostname": "string",
      "targetType": "string",
      "resourceId": "string",
      "environment": "string",
      "cfRouteId": "string",
      "status": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "cursor": "string",
  "hasMore": true
}

Create a DNS record

POST
/api/v1/platforms/{platformId}/stacks/{stackId}/dns

Path Parameters

platformId*string
stackId*string

Request Body

application/json

hostname*string
Length1 <= length
targetType*string
Length1 <= length
resourceId*string
Length1 <= length
environment*string
Length1 <= length

Response Body

application/json

application/json

curl -X POST "https://registry.svc.nno.app/api/v1/platforms/string/stacks/string/dns" \  -H "Content-Type: application/json" \  -d '{    "hostname": "string",    "targetType": "string",    "resourceId": "string",    "environment": "string"  }'
{
  "id": "string",
  "platformId": "string",
  "stackId": "string",
  "hostname": "string",
  "targetType": "string",
  "resourceId": "string",
  "environment": "string",
  "cfRouteId": "string",
  "status": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Get a DNS record by stack and ID

GET
/api/v1/platforms/{platformId}/stacks/{stackId}/dns/{dnsId}

Path Parameters

platformId*string
stackId*string
dnsId*string

Response Body

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/stacks/string/dns/string"
{
  "id": "string",
  "platformId": "string",
  "stackId": "string",
  "hostname": "string",
  "targetType": "string",
  "resourceId": "string",
  "environment": "string",
  "cfRouteId": "string",
  "status": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Delete a DNS record

DELETE
/api/v1/platforms/{platformId}/stacks/{stackId}/dns/{dnsId}

Path Parameters

platformId*string
stackId*string
dnsId*string

Response Body

application/json

curl -X DELETE "https://registry.svc.nno.app/api/v1/platforms/string/stacks/string/dns/string"
Empty
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Get a DNS record by platform and ID

GET
/api/v1/platforms/{platformId}/dns/{dnsId}

Path Parameters

platformId*string
dnsId*string

Response Body

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/dns/string"
{
  "id": "string",
  "platformId": "string",
  "stackId": "string",
  "hostname": "string",
  "targetType": "string",
  "resourceId": "string",
  "environment": "string",
  "cfRouteId": "string",
  "status": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

List pending custom domains

GET
/api/v1/domains/pending

Response Body

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/domains/pending"
{
  "data": [
    {
      "id": "string",
      "platformId": "string",
      "cfHostnameId": "string",
      "hostname": "string"
    }
  ]
}

List custom domains for a platform

GET
/api/v1/platforms/{platformId}/domains

Path Parameters

platformId*string

Query Parameters

limit?string
cursor?string

Response Body

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/platforms/string/domains"
{
  "data": [
    {
      "id": "string",
      "platformId": "string",
      "dnsRecordId": "string",
      "hostname": "string",
      "targetDns": "string",
      "cfHostnameId": "string",
      "sslStatus": "string",
      "status": "string",
      "verifiedAt": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "cursor": "string"
}

Create a custom domain

POST
/api/v1/platforms/{platformId}/domains

Path Parameters

platformId*string

Request Body

application/json

dnsRecordId*string
Length1 <= length
hostname*string
Length1 <= length
targetDns*string
Length1 <= length
cfHostnameId?string
Length1 <= length

Response Body

application/json

application/json

curl -X POST "https://registry.svc.nno.app/api/v1/platforms/string/domains" \  -H "Content-Type: application/json" \  -d '{    "dnsRecordId": "string",    "hostname": "string",    "targetDns": "string"  }'
{
  "id": "string",
  "platformId": "string",
  "dnsRecordId": "string",
  "hostname": "string",
  "targetDns": "string",
  "cfHostnameId": "string",
  "sslStatus": "string",
  "status": "string",
  "verifiedAt": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Update a custom domain

PATCH
/api/v1/platforms/{platformId}/domains/{domainId}

Path Parameters

platformId*string
domainId*string

Request Body

application/json

sslStatus?string
Length1 <= length
status?string
Length1 <= length
verifiedAt?integer
cfHostnameId?string
Length1 <= length

Response Body

application/json

application/json

application/json

curl -X PATCH "https://registry.svc.nno.app/api/v1/platforms/string/domains/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "platformId": "string",
  "dnsRecordId": "string",
  "hostname": "string",
  "targetDns": "string",
  "cfHostnameId": "string",
  "sslStatus": "string",
  "status": "string",
  "verifiedAt": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Delete a custom domain

DELETE
/api/v1/platforms/{platformId}/domains/{domainId}

Path Parameters

platformId*string
domainId*string

Response Body

application/json

curl -X DELETE "https://registry.svc.nno.app/api/v1/platforms/string/domains/string"
Empty
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

List onboarding sessions (operator-only)

GET
/api/v1/onboarding/admin/sessions

Query Parameters

limit?string
cursor?string
status?string

Response Body

application/json

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/onboarding/admin/sessions"
{
  "data": [
    {
      "id": "string",
      "platformId": "string",
      "userId": "string",
      "status": "string",
      "steps": null,
      "currentStep": "string",
      "metadata": null,
      "stackTemplateId": "string",
      "tier": "string",
      "provisionJobId": "string",
      "startedAt": "string",
      "completedAt": "string",
      "expiresAt": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string",
    "total": 0
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Create an onboarding session

POST
/api/v1/onboarding

Response Body

application/json

application/json

curl -X POST "https://registry.svc.nno.app/api/v1/onboarding"
{
  "onboardingId": "string",
  "jobId": "string",
  "status": "string",
  "steps": [
    null
  ]
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Get an onboarding session

GET
/api/v1/onboarding/{onboardingId}

Path Parameters

onboardingId*string

Response Body

application/json

application/json

application/json

curl -X GET "https://registry.svc.nno.app/api/v1/onboarding/string"
{
  "id": "string",
  "platformId": "string",
  "userId": "string",
  "status": "string",
  "steps": null,
  "currentStep": "string",
  "metadata": null,
  "stackTemplateId": "string",
  "tier": "string",
  "provisionJobId": "string",
  "startedAt": "string",
  "completedAt": "string",
  "expiresAt": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Update an onboarding session

PATCH
/api/v1/onboarding/{onboardingId}

Path Parameters

onboardingId*string

Request Body

application/json

steps?string
currentStep?string
metadata?string
status?string
Value in"in_progress" | "completed" | "failed" | "cancelled"
provisionJobId?string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://registry.svc.nno.app/api/v1/onboarding/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "platformId": "string",
  "userId": "string",
  "status": "string",
  "steps": null,
  "currentStep": "string",
  "metadata": null,
  "stackTemplateId": "string",
  "tier": "string",
  "provisionJobId": "string",
  "startedAt": "string",
  "completedAt": "string",
  "expiresAt": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

List onboarding sessions (operator-only)

GET
/admin/sessions

Query Parameters

limit?string
cursor?string
status?string

Response Body

application/json

application/json

application/json

curl -X GET "https://registry.svc.nno.app/admin/sessions"
{
  "data": [
    {
      "id": "string",
      "platformId": "string",
      "userId": "string",
      "status": "string",
      "steps": null,
      "currentStep": "string",
      "metadata": null,
      "stackTemplateId": "string",
      "tier": "string",
      "provisionJobId": "string",
      "startedAt": "string",
      "completedAt": "string",
      "expiresAt": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string",
    "total": 0
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Create an onboarding session

POST
/

Response Body

application/json

application/json

curl -X POST "https://registry.svc.nno.app"
{
  "onboardingId": "string",
  "jobId": "string",
  "status": "string",
  "steps": [
    null
  ]
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Get an onboarding session

GET
/{onboardingId}

Path Parameters

onboardingId*string

Response Body

application/json

application/json

application/json

curl -X GET "https://registry.svc.nno.app/string"
{
  "id": "string",
  "platformId": "string",
  "userId": "string",
  "status": "string",
  "steps": null,
  "currentStep": "string",
  "metadata": null,
  "stackTemplateId": "string",
  "tier": "string",
  "provisionJobId": "string",
  "startedAt": "string",
  "completedAt": "string",
  "expiresAt": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}

Update an onboarding session

PATCH
/{onboardingId}

Path Parameters

onboardingId*string

Request Body

application/json

steps?string
currentStep?string
metadata?string
status?string
Value in"in_progress" | "completed" | "failed" | "cancelled"
provisionJobId?string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://registry.svc.nno.app/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "platformId": "string",
  "userId": "string",
  "status": "string",
  "steps": null,
  "currentStep": "string",
  "metadata": null,
  "stackTemplateId": "string",
  "tier": "string",
  "provisionJobId": "string",
  "startedAt": "string",
  "completedAt": "string",
  "expiresAt": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": null
  }
}