Blockstream Enterprise

Request

PoliciesListRequest

interface PoliciesListRequest {
  action: 'get'
  resource: '/policies'
  details?: {
    limit: number | undefined
    offset: number | undefined
    sort_by: 'created_at' | 'updated_at' | 'name' | 'priority' | undefined
    sort: 'asc' | 'desc' | undefined
    filters: {
      resource: {
        type: 'partial'
        value: string
      } | { type: 'exact'; value: string } | { type: 'exclude'; value: string } | { type: 'or'; value: unknown[] } | { type: 'and'; value: unknown[] } | undefined
      action: string | undefined
      name: string | undefined
    } | undefined
  } | undefined
}

Prop

Type

Response

PoliciesListResponse_success

interface PoliciesListResponse_success {
  status: 'success'
  error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
  message?: string | undefined
  details: {
    plid: string
    name: string
    description: string | undefined
    resource: string
    action: string
    priority: number
    expression: string
    decision_on_true: 'ALLOW' | 'DENY' | 'REVIEW'
    review_expression: string | undefined
    created_at: string
    updated_at: string
    created_by: string
    updated_by: string
    status: 'success' | 'pending' | 'failed' | 'unauthorized' | 'rejected'
  } []
  metadata: {
    total_count: number
  }
}

Prop

Type

PoliciesListResponse_failed | pending | unauthorized | rejected

interface PoliciesListResponse_failed | pending | unauthorized | rejected {
  status: 'failed' | 'pending' | 'unauthorized' | 'rejected'
  error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
  message?: string | undefined
}

Prop

Type

Example

import { resourceSchema } from '@blockstream/ecs-js-sdk'
import { broadcastRequest } from './broadcaster'

const response = await broadcastRequest<
  typeof resourceSchema.shape.policies.shape.list
>(
  {
    action: 'get',
    resource: '/policies',
    details: {
      // TODO: fill in required fields
    },
  },
  blockstream,
)

List Policies

Request

Response

Example

On this page