Outpost API

Tenants

Endpoint:http://localhost:3333/api/v1

List Tenants

GET
http://localhost:3333/api/v1
/tenants

List Tenantsquery Parameters

  • limitinteger · min: 1 · max: 100
    Default: 20
  • orderstring · enum
    Enum values:
    asc
    desc
    Default: desc
  • nextstring
  • prevstring

List TenantsResponses

    • dataobject[]
    • nextstring
    • prevstring
    • countinteger

Get Tenant

GET
http://localhost:3333/api/v1
/tenants/{tenant_id}

Get Tenantpath Parameters

  • tenant_idstring · required

Get TenantResponses

    • idstring
    • destinations_countinteger
    • topicsstring[]
    • metadataobject
    • created_atstring · date-time
    • updated_atstring · date-time

Create or Update Tenant

PUT
http://localhost:3333/api/v1
/tenants/{tenant_id}

Create or Update Tenantpath Parameters

  • tenant_idstring · required

Create or Update TenantRequest Body
optional

  • metadataobject

Create or Update TenantResponses

    • idstring
    • destinations_countinteger
    • topicsstring[]
    • metadataobject
    • created_atstring · date-time
    • updated_atstring · date-time

Delete Tenant

DELETE
http://localhost:3333/api/v1
/tenants/{tenant_id}

Delete Tenantpath Parameters

  • tenant_idstring · required

Delete TenantResponses

    • successboolean

Get Portal Redirect URL

GET
http://localhost:3333/api/v1
/tenants/{tenant_id}/portal

Get Portal Redirect URLpath Parameters

  • tenant_idstring · required

Get Portal Redirect URLquery Parameters

  • themestring · enum
    Enum values:
    light
    dark

Get Portal Redirect URLResponses

    • redirect_urlstring · url
    • tenant_idstring

Get Tenant JWT Token

GET
http://localhost:3333/api/v1
/tenants/{tenant_id}/token

Get Tenant JWT Tokenpath Parameters

  • tenant_idstring · required

Get Tenant JWT TokenResponses

    • tokenstring
    • tenant_idstring