MechaMental
Api reference

App Tokens

List App Tokens

GET
/v1/orgs/{org_id}/apps/{app_id}/tokens

Path Parameters

org_id*Org Id
app_id*App Id

Header Parameters

authorization?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://loading/v1/orgs/string/apps/string/tokens"
{
  "tokens": [
    {
      "token_id": "string",
      "token_type": "pat",
      "owner_type": "user",
      "owner_id": "string",
      "org_id": "string",
      "name": "string",
      "description": "string",
      "prefix": "string",
      "scopes": [
        "string"
      ],
      "permissions": [
        "string"
      ],
      "workspace_ids": [
        "string"
      ],
      "namespace_ids": [
        "string"
      ],
      "environment_ids": [
        "string"
      ],
      "endpoint_paths": [
        "string"
      ],
      "rate_limit_rps": 0,
      "rate_limit_burst": 0,
      "created_by_user_id": "string",
      "issued_at": "string",
      "expires_at": "string",
      "last_used_at": "string",
      "revoked_at": "string",
      "revoked_reason": "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
}

Create App Token

POST
/v1/orgs/{org_id}/apps/{app_id}/tokens

Path Parameters

org_id*Org Id
app_id*App Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/v1/orgs/string/apps/string/tokens" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "token": {
    "token_id": "string",
    "token_type": "pat",
    "owner_type": "user",
    "owner_id": "string",
    "org_id": "string",
    "name": "string",
    "description": "string",
    "prefix": "string",
    "scopes": [
      "string"
    ],
    "permissions": [
      "string"
    ],
    "workspace_ids": [
      "string"
    ],
    "namespace_ids": [
      "string"
    ],
    "environment_ids": [
      "string"
    ],
    "endpoint_paths": [
      "string"
    ],
    "rate_limit_rps": 0,
    "rate_limit_burst": 0,
    "created_by_user_id": "string",
    "issued_at": "string",
    "expires_at": "string",
    "last_used_at": "string",
    "revoked_at": "string",
    "revoked_reason": "string"
  },
  "plaintext_token": "string",
  "refresh_token_plaintext": "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
}

Revoke App Token

DELETE
/v1/orgs/{org_id}/apps/{app_id}/tokens/{token_id}

Path Parameters

org_id*Org Id
app_id*App Id
token_id*Token Id

Header Parameters

authorization?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://loading/v1/orgs/string/apps/string/tokens/string"
Empty
{
  "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
}

App Token Policies

Previous Page

Approvals

Next Page