Skip to content
Shortcut: /, ⌘K or Ctrl+K

Projects

View as Markdown

Create project

POST/platform/projectsPlatform API
Base URL
https://api.polymorfa.com
Required permission
sessions:manage

Creates a project in development. A Free team can have one active project; creating another returns 409 with code payg_required until the team upgrades to Pay-As-You-Go. Pay-As-You-Go teams have no project limit.

Team keys require sessions:manage. Project tokens are not accepted.

Body

  • namestringrequiredlength1–200

    Human-readable name for this resource.

  • defaultTierstring

    Specifies default tier for this schema.

    Allowed valuesfreestandardpro
    Default "standard"
  • iconobject

    Structured icon values for this schema.

    Show 4 child fields

Responses

  • 200Success
    • dataobjectrequired

      Structured data carried by this object.

      Show 8 child fields
    Show 3 headers
  • 400A path, query, or request-body value did not pass validation.
  • 401Missing/invalid credential for this audience.
  • 403Authenticated but lacks the required scope/role/audience.
  • 409The request conflicts with the resource's current state.
POST /platform/projectscURL
Not available with the Test key. Use a team key or project token.
curl -X POST "https://api.polymorfa.com/platform/projects" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'
Response
{
  "data": {
    "id": "00000000-0000-4000-8000-000000000000",
    "teamId": "00000000-0000-4000-8000-000000000000",
    "name": "string",
    "slug": "string",
    "icon": {
      "type": "string",
      "value": "string"
    },
    "defaultTier": "free",
    "isActive": true,
    "stage": "development"
  }
}

List projects

GET/platform/projectsPlatform API
Base URL
https://api.polymorfa.com
Required permission
sessions:read

Public Management API. Team keys require sessions:read. Project tokens are not accepted.

Responses

  • 200Success
    • dataanyrequired

      Operation result.

    Show 3 headers
  • 401Missing/invalid credential for this audience.
  • 403Authenticated but lacks the required scope/role/audience.
GET /platform/projectscURL
Not available with the Test key. Use a team key or project token.
curl "https://api.polymorfa.com/platform/projects" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "data": null
}

Request production enrollment

POST/platform/projects/{projectId}/promotePlatform API
Base URL
https://api.polymorfa.com
Required permission
sessions:manage

Creates a durable production-enrollment operation. The team must be on Pay-As-You-Go; a Free team receives 409 with code payg_required and upgrades from Billing first. The project stays in development until provisioning succeeds. Poll the returned operationId for progress.

Requires sessions:manage. Project tokens only access resources in their own project.

Path parameters

  • projectIdstring (uuid)required

    Identifier of the Polymorfa project that owns this resource.

Body

  • businessobjectrequired

    Structured business values for this management production enrollment request.

    Show 3 child fields

Responses

  • 200Success
    • dataobjectrequired

      Structured data carried by this object.

      Show 8 child fields
    Show 3 headers
  • 400A path, query, or request-body value did not pass validation.
  • 401Missing/invalid credential for this audience.
  • 403Authenticated but lacks the required scope/role/audience.
  • 404The requested resource was not found inside the authenticated team or project scope.
  • 409The request conflicts with the resource's current state.
POST /platform/projects/{projectId}/promotecURL
Not available with the Test key. Use a team key or project token.
curl -X POST "https://api.polymorfa.com/platform/projects/<projectId>/promote" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22" \
  -H "Content-Type: application/json" \
  -d '{
  "business": {
    "name": "string",
    "website": "https://example.com",
    "supportEmail": "person@example.com"
  }
}'
Response
{
  "data": {
    "id": "00000000-0000-4000-8000-000000000000",
    "teamId": "00000000-0000-4000-8000-000000000000",
    "name": "string",
    "slug": "string",
    "stage": "development",
    "operationId": "00000000-0000-4000-8000-000000000000",
    "enrollmentStatus": "requested",
    "billingMode": "payg"
  }
}

Approve production enrollment

POST/platform/projects/{projectId}/production-enrollments/{operationId}/approvePlatform API
Base URL
https://api.polymorfa.com
Required permission
sessions:manage

Resumes a production-enrollment operation that requires approval.

Requires sessions:manage. Project tokens only access resources in their own project.

Path parameters

  • projectIdstring (uuid)required

    Identifier of the Polymorfa project that owns this resource.

  • operationIdstring (uuid)required

    Identifier used to retrieve the asynchronous operation.

Body

Responses

  • 200Success
    • dataobjectrequired

      Structured data carried by this object.

      Show 3 child fields
    Show 3 headers
  • 400A path, query, or request-body value did not pass validation.
  • 401Missing/invalid credential for this audience.
  • 403Authenticated but lacks the required scope/role/audience.
  • 409The request conflicts with the resource's current state.
POST /platform/projects/{projectId}/production-enrollments/{operationId}/approvecURL
Not available with the Test key. Use a team key or project token.
curl -X POST "https://api.polymorfa.com/platform/projects/<projectId>/production-enrollments/<operationId>/approve" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "operationId": "00000000-0000-4000-8000-000000000000",
    "action": "approve",
    "accepted": true
  }
}

Cancel production enrollment

POST/platform/projects/{projectId}/production-enrollments/{operationId}/cancelPlatform API
Base URL
https://api.polymorfa.com
Required permission
sessions:manage

Requests cancellation of an active production-enrollment operation. Provisioned resources are compensated before cancellation completes.

Requires sessions:manage. Project tokens only access resources in their own project.

Path parameters

  • projectIdstring (uuid)required

    Identifier of the Polymorfa project that owns this resource.

  • operationIdstring (uuid)required

    Identifier used to retrieve the asynchronous operation.

Body

Responses

  • 200Success
    • dataobjectrequired

      Structured data carried by this object.

      Show 3 child fields
    Show 3 headers
  • 400A path, query, or request-body value did not pass validation.
  • 401Missing/invalid credential for this audience.
  • 403Authenticated but lacks the required scope/role/audience.
  • 409The request conflicts with the resource's current state.
POST /platform/projects/{projectId}/production-enrollments/{operationId}/cancelcURL
Not available with the Test key. Use a team key or project token.
curl -X POST "https://api.polymorfa.com/platform/projects/<projectId>/production-enrollments/<operationId>/cancel" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "operationId": "00000000-0000-4000-8000-000000000000",
    "action": "approve",
    "accepted": true
  }
}