Organizations

Manage the organizations of the Krenalis instance.

All these endpoints require a Platform Management API key instead of the standard API key and are subject to the following rate limits:

  • Rate: 100 requests per minute
  • Capacity: 100 requests

List organizations

Returns the organizations, sorted by name.

Request

  • first

    int

    The number of organizations to skip before starting to return results. The default value is 0.

  • limit

    int

    The maximum number of organizations to return. If not provided, the default value is 100.

    It must be between 1 and 1,000.

Response

  • organizations

    array of object

    The list of organizations.

    • id

      string

      The organization's unique identifier.

    • name

      string

      The organization's name.

    • enabled

      boolean

      Indicates if the organization is enabled. Use the Set status endpoint to change the organization's status.

    • limits

      object

      The resource limits of the organization.

      • limits.members

        int

        The maximum number of members allowed in the organization.

        It is between 1 and 10,000.

      • limits.accessKeys

        int

        The maximum number of access keys (API and MCP) allowed in the organization.

        It is between 0 and 1,000.

      • limits.workspaces

        int

        The maximum number of workspaces allowed in the organization.

        It is between 0 and 1,000.

      • limits.connectors

        int

        The maximum number of unique connectors the organization can use in connections and file pipelines.

        It is between 0 and 1,000.

      • limits.connections

        int

        The maximum number of connections allowed in the organization.

        It is between 0 and 10,000.

      • limits.pipelines

        int

        The maximum number of pipelines allowed in the organization.

        It is between 0 and 10,000.

      • limits.rates

        object

        The API rate limits of the organization.

        • limits.rates.organizationSpecific

          object

          The rate limits specific to organization-level API requests.

          Workspace-level requests and event ingestion requests are not included and can be configured separately using the workspaceSpecific and eventsSpecific fields.

          • limits.rates.organizationSpecific.ratePerMinute

            int

            The rate, measured in requests per minute.

            It is between 60 and 20,000.

          • limits.rates.organizationSpecific.maxCapacity

            int

            The maximum capacity, measured in requests.

            It is between 1 and 10,000.

        • limits.rates.workspaceSpecific

          object

          The rate limits specific to API requests targeting a workspace.

          Event ingestion requests are not included and can be configured separately using the eventsSpecific field. The limits apply independently to each workspace.

          • limits.rates.workspaceSpecific.ratePerMinute

            int

            The rate, measured in requests per minute.

            It is between 60 and 20,000.

          • limits.rates.workspaceSpecific.maxCapacity

            int

            The maximum capacity, measured in requests.

            It is between 1 and 10,000.

        • limits.rates.eventsSpecific

          object

          The event ingestion rate limits that apply to each workspace.

          The limits are measured in events rather than API requests.

          • limits.rates.eventsSpecific.ratePerMinute

            int

            The rate, measured in events per minute.

            It is between 1,000 and 1,000,000.

          • limits.rates.eventsSpecific.maxCapacity

            int

            The maximum capacity, measured in events.

            It is between 20,000 and 100,000.

    • counts

      object

      The number of resources currently used by the organization.

      • counts.members

        int

        The number of members in the organization.

        It is between 1 and 10,000.

      • counts.accessKeys

        int

        The number of access keys in the organization.

        It is between 0 and 1,000.

      • counts.workspaces

        int

        The number of workspaces in the organization.

        It is between 0 and 1,000.

      • counts.connectors

        int

        The number of unique connectors the organization uses in connections and file pipelines.

        It is between 0 and 1,000.

      • counts.connections

        int

        The number of connections in the organization.

        It is between 0 and 10,000.

      • counts.pipelines

        int

        The number of pipelines in the organization.

        It is between 0 and 10,000.
GET /v1/organizations
curl -G https://example.com/v1/organizations \
-H "Authorization: Bearer plat_xxxxxxx" \
-d "limit=100"
Response
{
  "organizations": [
    {
      "id": "3nV8kQ5wA6pT",
      "name": "Acme Corp",
      "enabled": true,
      "limits": {
        "members": 20,
        "accessKeys": 100,
        "workspaces": 8,
        "connectors": 15,
        "connections": 30,
        "pipelines": 120,
        "rates": {
          "organizationSpecific": {
            "ratePerMinute": 3000,
            "maxCapacity": 500
          },
          "workspaceSpecific": {
            "ratePerMinute": 3000,
            "maxCapacity": 500
          },
          "eventsSpecific": {
            "ratePerMinute": 100000,
            "maxCapacity": 20000
          }
        }
      },
      "counts": {
        "members": 7,
        "accessKeys": 5,
        "workspaces": 3,
        "connectors": 12,
        "connections": 29,
        "pipelines": 41
      }
    }
  ]
}
Errors
401
Authorization header is missing or invalid

Get organization

Returns a single organization by its identifier.

Request

  • :id

    string Required

    The organization's identifier.

Response

  • id

    string

    The organization's unique identifier.

  • name

    string

    The organization's name.

  • enabled

    boolean

    Indicates if the organization is enabled. Use the Set status endpoint to change the organization's status.

  • limits

    object

    The resource limits of the organization.

    • limits.members

      int

      The maximum number of members allowed in the organization.

      It is between 1 and 10,000.

    • limits.accessKeys

      int

      The maximum number of access keys (API and MCP) allowed in the organization.

      It is between 0 and 1,000.

    • limits.workspaces

      int

      The maximum number of workspaces allowed in the organization.

      It is between 0 and 1,000.

    • limits.connectors

      int

      The maximum number of unique connectors the organization can use in connections and file pipelines.

      It is between 0 and 1,000.

    • limits.connections

      int

      The maximum number of connections allowed in the organization.

      It is between 0 and 10,000.

    • limits.pipelines

      int

      The maximum number of pipelines allowed in the organization.

      It is between 0 and 10,000.

    • limits.rates

      object

      The API rate limits of the organization.

      • limits.rates.organizationSpecific

        object

        The rate limits specific to organization-level API requests.

        Workspace-level requests and event ingestion requests are not included and can be configured separately using the workspaceSpecific and eventsSpecific fields.

        • limits.rates.organizationSpecific.ratePerMinute

          int

          The rate, measured in requests per minute.

          It is between 60 and 20,000.

        • limits.rates.organizationSpecific.maxCapacity

          int

          The maximum capacity, measured in requests.

          It is between 1 and 10,000.

      • limits.rates.workspaceSpecific

        object

        The rate limits specific to API requests targeting a workspace.

        Event ingestion requests are not included and can be configured separately using the eventsSpecific field. The limits apply independently to each workspace.

        • limits.rates.workspaceSpecific.ratePerMinute

          int

          The rate, measured in requests per minute.

          It is between 60 and 20,000.

        • limits.rates.workspaceSpecific.maxCapacity

          int

          The maximum capacity, measured in requests.

          It is between 1 and 10,000.

      • limits.rates.eventsSpecific

        object

        The event ingestion rate limits that apply to each workspace.

        The limits are measured in events rather than API requests.

        • limits.rates.eventsSpecific.ratePerMinute

          int

          The rate, measured in events per minute.

          It is between 1,000 and 1,000,000.

        • limits.rates.eventsSpecific.maxCapacity

          int

          The maximum capacity, measured in events.

          It is between 20,000 and 100,000.

  • counts

    object

    The number of resources currently used by the organization.

    • counts.members

      int

      The number of members in the organization.

      It is between 1 and 10,000.

    • counts.accessKeys

      int

      The number of access keys in the organization.

      It is between 0 and 1,000.

    • counts.workspaces

      int

      The number of workspaces in the organization.

      It is between 0 and 1,000.

    • counts.connectors

      int

      The number of unique connectors the organization uses in connections and file pipelines.

      It is between 0 and 1,000.

    • counts.connections

      int

      The number of connections in the organization.

      It is between 0 and 10,000.

    • counts.pipelines

      int

      The number of pipelines in the organization.

      It is between 0 and 10,000.
GET /v1/organizations/:id
curl https://example.com/v1/organizations/3nV8kQ5wA6pT \
-H "Authorization: Bearer plat_xxxxxxx"
Response
{
  "id": "3nV8kQ5wA6pT",
  "name": "Acme Corp",
  "enabled": true,
  "limits": {
    "members": 20,
    "accessKeys": 100,
    "workspaces": 8,
    "connectors": 15,
    "connections": 30,
    "pipelines": 120,
    "rates": {
      "organizationSpecific": {
        "ratePerMinute": 3000,
        "maxCapacity": 500
      },
      "workspaceSpecific": {
        "ratePerMinute": 3000,
        "maxCapacity": 500
      },
      "eventsSpecific": {
        "ratePerMinute": 100000,
        "maxCapacity": 20000
      }
    }
  },
  "counts": {
    "members": 7,
    "accessKeys": 5,
    "workspaces": 3,
    "connectors": 12,
    "connections": 29,
    "pipelines": 41
  }
}
Errors
401
Authorization header is missing or invalid
404
organization does not exist

Create organization

Creates a new organization.

Request

  • name

    string Required

    The organization's name.

    Must be a non-empty string with a maximum of 45 characters.

  • enabled

    boolean

    Indicates if the organization is enabled once created. Logins to workspaces of a disabled organization, as well as calls made with API and MCP keys to its workspaces, return an OrganizationDisabled error. The only exception is event ingestion authenticated with an event write key, which fails with a ServiceUnavailable error instead. Calls with Platform Management API keys are unaffected. Use the Set status endpoint to change the organization's status.

  • limits

    object Required

    The resource limits of the organization.

    • limits.members

      int Required

      The maximum number of members allowed in the organization.

      It must be between 1 and 10,000.

    • limits.accessKeys

      int Required

      The maximum number of access keys (API and MCP) allowed in the organization.

      It must be between 0 and 1,000.

    • limits.workspaces

      int Required

      The maximum number of workspaces allowed in the organization.

      It must be between 0 and 1,000.

    • limits.connectors

      int Required

      The maximum number of unique connectors the organization can use in connections and file pipelines.

      It must be between 0 and 1,000.

    • limits.connections

      int Required

      The maximum number of connections allowed in the organization.

      It must be between 0 and 10,000.

    • limits.pipelines

      int Required

      The maximum number of pipelines allowed in the organization.

      It must be between 0 and 10,000.

    • limits.rates

      object Required

      The API rate limits of the organization.

      • limits.rates.organizationSpecific

        object Required

        The rate limits specific to organization-level API requests.

        Workspace-level requests and event ingestion requests are not included and can be configured separately using the workspaceSpecific and eventsSpecific fields.

        • limits.rates.organizationSpecific.ratePerMinute

          int Required

          The rate, measured in requests per minute.

          It must be between 60 and 20,000.

        • limits.rates.organizationSpecific.maxCapacity

          int Required

          The maximum capacity, measured in requests.

          It must be between 1 and 10,000.

      • limits.rates.workspaceSpecific

        object Required

        The rate limits specific to API requests targeting a workspace.

        Event ingestion requests are not included and can be configured separately using the eventsSpecific field. The limits apply independently to each workspace.

        • limits.rates.workspaceSpecific.ratePerMinute

          int Required

          The rate, measured in requests per minute.

          It must be between 60 and 20,000.

        • limits.rates.workspaceSpecific.maxCapacity

          int Required

          The maximum capacity, measured in requests.

          It must be between 1 and 10,000.

      • limits.rates.eventsSpecific

        object Required

        The event ingestion rate limits that apply to each workspace.

        The limits are measured in events rather than API requests.

        • limits.rates.eventsSpecific.ratePerMinute

          int Required

          The rate, measured in events per minute.

          It must be between 1,000 and 1,000,000.

        • limits.rates.eventsSpecific.maxCapacity

          int Required

          The maximum capacity, measured in events.

          It must be between 20,000 and 100,000.

Response

  • id

    string

    The identifier of the created organization.
POST /v1/organizations
curl https://example.com/v1/organizations \
-H "Authorization: Bearer plat_xxxxxxx" \
--json '{
"name": "Acme Corp",
"enabled": true,
"limits": {
"members": 20,
"accessKeys": 100,
"workspaces": 8,
"connectors": 15,
"connections": 30,
"pipelines": 120,
"rates": {
"organizationSpecific": {
"ratePerMinute": 3000,
"maxCapacity": 500
},
"workspaceSpecific": {
"ratePerMinute": 3000,
"maxCapacity": 500
},
"eventsSpecific": {
"ratePerMinute": 100000,
"maxCapacity": 20000
}
}
}
}'
Response
{
  "id": "3nV8kQ5wA6pT"
}
Errors
401
Authorization header is missing or invalid

Update organization

Updates the name of an organization.

Request

  • :id

    string Required

    The organization's identifier.

  • name

    string Required

    The organization's name.

    Must be a non-empty string with a maximum of 45 characters.

  • limits

    object Required

    The resource limits of the organization.

    • limits.members

      int Required

      The maximum number of members allowed in the organization.

      It must be between 1 and 10,000.

    • limits.accessKeys

      int Required

      The maximum number of access keys (API and MCP) allowed in the organization.

      It must be between 0 and 1,000.

    • limits.workspaces

      int Required

      The maximum number of workspaces allowed in the organization.

      It must be between 0 and 1,000.

    • limits.connectors

      int Required

      The maximum number of unique connectors the organization can use in connections and file pipelines.

      It must be between 0 and 1,000.

    • limits.connections

      int Required

      The maximum number of connections allowed in the organization.

      It must be between 0 and 10,000.

    • limits.pipelines

      int Required

      The maximum number of pipelines allowed in the organization.

      It must be between 0 and 10,000.

    • limits.rates

      object Required

      The API rate limits of the organization.

      • limits.rates.organizationSpecific

        object Required

        The rate limits specific to organization-level API requests.

        Workspace-level requests and event ingestion requests are not included and can be configured separately using the workspaceSpecific and eventsSpecific fields.

        • limits.rates.organizationSpecific.ratePerMinute

          int Required

          The rate, measured in requests per minute.

          It must be between 60 and 20,000.

        • limits.rates.organizationSpecific.maxCapacity

          int Required

          The maximum capacity, measured in requests.

          It must be between 1 and 10,000.

      • limits.rates.workspaceSpecific

        object Required

        The rate limits specific to API requests targeting a workspace.

        Event ingestion requests are not included and can be configured separately using the eventsSpecific field. The limits apply independently to each workspace.

        • limits.rates.workspaceSpecific.ratePerMinute

          int Required

          The rate, measured in requests per minute.

          It must be between 60 and 20,000.

        • limits.rates.workspaceSpecific.maxCapacity

          int Required

          The maximum capacity, measured in requests.

          It must be between 1 and 10,000.

      • limits.rates.eventsSpecific

        object Required

        The event ingestion rate limits that apply to each workspace.

        The limits are measured in events rather than API requests.

        • limits.rates.eventsSpecific.ratePerMinute

          int Required

          The rate, measured in events per minute.

          It must be between 1,000 and 1,000,000.

        • limits.rates.eventsSpecific.maxCapacity

          int Required

          The maximum capacity, measured in events.

          It must be between 20,000 and 100,000.

Response

No response.
PUT /v1/organizations/:id
curl -X PUT https://example.com/v1/organizations/3nV8kQ5wA6pT \
-H "Authorization: Bearer plat_xxxxxxx" \
--json '{
"name": "Acme Corp",
"limits": {
"members": 20,
"accessKeys": 100,
"workspaces": 8,
"connectors": 15,
"connections": 30,
"pipelines": 120,
"rates": {
"organizationSpecific": {
"ratePerMinute": 3000,
"maxCapacity": 500
},
"workspaceSpecific": {
"ratePerMinute": 3000,
"maxCapacity": 500
},
"eventsSpecific": {
"ratePerMinute": 100000,
"maxCapacity": 20000
}
}
}
}'
Errors
401
Authorization header is missing or invalid
404
organization does not exist

Set status

Sets the status of an organization, which can be enabled or disabled.

Logins to workspaces of a disabled organization, as well as calls made with API and MCP keys to its workspaces, return an OrganizationDisabled error. The only exception is event ingestion authenticated with an event write key, which fails with a ServiceUnavailable error instead. Calls with Platform Management API keys are unaffected.

The organization's data and configuration are preserved and can be restored by enabling the organization again.

Request

  • :id

    string Required

    The organization's identifier.

  • enabled

    boolean Required

    Indicates if the organization is enabled.

Response

No response.
PUT /v1/organizations/:id/status
curl -X PUT https://example.com/v1/organizations/3nV8kQ5wA6pT/status \
-H "Authorization: Bearer plat_xxxxxxx" \
--json '{
"enabled": true
}'
Errors
404
organization does not exist

Delete organization

Deletes an organization and all its data.

Request

  • :id

    string Required

    The organization's identifier.

Response

No response.
DELETE /v1/organizations/:id
curl -X DELETE https://example.com/v1/organizations/3nV8kQ5wA6pT \
-H "Authorization: Bearer plat_xxxxxxx"
Errors
401
Authorization header is missing or invalid
404
organization does not exist