Get an app custom address – GET /v1/apps/{applicationId}/address

GET/v1/apps/{applicationId}/address

betaapiKeyworkspace

When to use

Read the app’s custom address and available organization namespaces.

For agents

Requires app read. Organization namespaces and their setup status are returned only to app admins. Only live namespaces accept address assignments. An organization admin must first delegate a dedicated subdomain using the four NS records in Organization Settings. Permute manages routing and HTTPS after delegation. Retain address.url (or null when absent) as expectedUrl for an update.

Example

typescript

import { PermuteClient } from '@permute/sdk';

const orgClient = new PermuteClient({
  apiKey: process.env.PERMUTE_API_KEY!,
});

const client = orgClient.withWorkspace(process.env.PERMUTE_WORKSPACE_ID!);

const result = await client.apps.address('appl_abcdefghijklmnopqrstuvwx');

Response

json

{
  "data": {
    "address": null,
    "canManage": true,
    "namespaces": [
      {
        "id": "domn_abcdefghijklmnopqrstuvwx",
        "hostname": "apps.example.com",
        "status": "live"
      }
    ]
  }
}