Apps

List Apps

Path Parameters

org_id*Org Id

Organization ID

workspace_id*Workspace Id

Workspace ID

Query Parameters

search?|

Search by name or description

limit?Limit

Maximum number of items to return (1-200)

Default50

Range1 <= value <= 200

cursor?|

Cursor for pagination (from previous response's next_cursor)

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/workspaces/string/apps"

{
  "total": 0,
  "has_more": false,
  "next_cursor": "string",
  "apps": [
    {
      "app_id": "string",
      "name": "string",
      "description": "string",
      "workspace_id": "string",
      "active_release_id": "string",
      "total_releases": 0,
      "draft_has_changes": false,
      "last_release_at": "2019-08-24T14:15:22Z",
      "created_by": "string",
      "parameters": [
        {
          "name": "string",
          "type": "secret",
          "resolution_mode": "fixed",
          "description": "string",
          "required": true,
          "default_value": "string"
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Create App

Path Parameters

org_id*Org Id

Organization ID

workspace_id*Workspace Id

Workspace ID

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

pk?|

Partition key: WORKSPACE#{workspace_id} (not stored)

sk?|

Sort key: APP#{id} (not stored)

app_id?App Id

Unique identifier for the app

workspace_id*Workspace Id

The workspace this app belongs to

org_id?|

Organization ID

name*Name

The name of the app

description?|

A brief description of the app

created_by?|

User ID of the app creator (audit only)

active_release_id?|

Currently active release serving production traffic

total_releases?Total Releases

Total number of releases created for this app

Default0

draft_has_changes?Draft Has Changes

True if draft workspace has unpublished changes since last release

Defaultfalse

last_release_at?|

Timestamp of the most recent release creation

namespace_ids?array<string>

List of namespace IDs associated with the app

node_ids?array<string>

List of node IDs associated with the app

endpoint_ids?array<string>

List of endpoint IDs in the draft workspace

source_ids?array<string>

List of static source IDs associated with the app

augmentation_ids?array<string>

List of augmentation IDs in the draft workspace

parameters?array<>

Parameter declarations for this app. Used by all augmentations in the app.

created_at?Created At

ISO 8601 timestamp

updated_at?Updated At

ISO 8601 timestamp

Response Body

`application/json`

curl -X POST "https://loading/v1/orgs/string/workspaces/string/apps" \  -H "Content-Type: application/json" \  -d '{    "workspace_id": "string",    "name": "string"  }'

{
  "message": "string",
  "app": {
    "app_id": "string",
    "name": "string",
    "description": "string",
    "workspace_id": "string",
    "active_release_id": "string",
    "total_releases": 0,
    "draft_has_changes": false,
    "last_release_at": "2019-08-24T14:15:22Z",
    "created_by": "string",
    "parameters": [
      {
        "name": "string",
        "type": "secret",
        "resolution_mode": "fixed",
        "description": "string",
        "required": true,
        "default_value": "string"
      }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Get App

Path Parameters

org_id*Org Id

Organization ID

app_id*App Id

App ID

workspace_id*Workspace Id

Workspace ID

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/workspaces/string/apps/string"

{
  "app_id": "string",
  "name": "string",
  "description": "string",
  "workspace_id": "string",
  "active_release_id": "string",
  "total_releases": 0,
  "draft_has_changes": false,
  "last_release_at": "2019-08-24T14:15:22Z",
  "created_by": "string",
  "parameters": [
    {
      "name": "string",
      "type": "secret",
      "resolution_mode": "fixed",
      "description": "string",
      "required": true,
      "default_value": "string"
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Delete App

Path Parameters

org_id*Org Id

Organization ID

app_id*App Id

App ID

workspace_id*Workspace Id

Workspace ID

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X DELETE "https://loading/v1/orgs/string/workspaces/string/apps/string"

{
  "message": "string"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Update App

Path Parameters

org_id*Org Id

Organization ID

app_id*App Id

App ID

workspace_id*Workspace Id

Workspace ID

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

[key: string]?any

Response Body

`application/json`

curl -X PUT "https://loading/v1/orgs/string/workspaces/string/apps/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "message": "string",
  "app": {
    "app_id": "string",
    "name": "string",
    "description": "string",
    "workspace_id": "string",
    "active_release_id": "string",
    "total_releases": 0,
    "draft_has_changes": false,
    "last_release_at": "2019-08-24T14:15:22Z",
    "created_by": "string",
    "parameters": [
      {
        "name": "string",
        "type": "secret",
        "resolution_mode": "fixed",
        "description": "string",
        "required": true,
        "default_value": "string"
      }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

201application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`