Outpost API

​Tenants

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

​List Tenants

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

​List Tenants › query Parameters

  • limitinteger · min: 1 · max: 100
    Default: 20
  • order_bystring · enum
    Enum values:
    created_at
    Default: created_at
  • dirstring · enum
    Enum values:
    asc
    desc
    Default: desc
  • created_at[gte]string · date-time
  • created_at[lte]string · date-time
  • nextstring
  • prevstring

​List Tenants › Responses

    • modelsobject[]
    • paginationobject
    • countinteger

​Get Tenant

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

​Get Tenant › path Parameters

  • tenant_idstring · required

​Get Tenant › Responses

    • 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 Tenant › path Parameters

  • tenant_idstring · required

​Create or Update Tenant › Request Body
optional

  • metadataobject

​Create or Update Tenant › Responses

    • 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 Tenant › path Parameters

  • tenant_idstring · required

​Delete Tenant › Responses

    • successboolean

​Get Portal Redirect URL

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

​Get Portal Redirect URL › path Parameters

  • tenant_idstring · required

​Get Portal Redirect URL › query Parameters

  • themestring · enum
    Enum values:
    light
    dark

​Get Portal Redirect URL › Responses

    • redirect_urlstring · url
    • tenant_idstring

​Get Tenant JWT Token

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

​Get Tenant JWT Token › path Parameters

  • tenant_idstring · required

​Get Tenant JWT Token › Responses

    • tokenstring
    • tenant_idstring
HealthDestinations