Type Alias PolicyAPI

type PolicyAPI = {
    create(
        id: string,
        rego: string,
        pretty?: boolean,
        metrics?: boolean,
    ): Promise<Record<string, never>>;
    delete(
        id: string,
        pretty?: boolean,
        metrics?: boolean,
    ): Promise<Record<string, never>>;
    get(id: string, pretty: boolean): Promise<GetPolicyResponse>;
    list(): Promise<ListPoliciesResponse>;
    put(
        id: string,
        rego: string,
        pretty?: boolean,
        metrics?: boolean,
    ): Promise<Record<string, never>>;
    update(
        id: string,
        rego: string,
        pretty?: boolean,
        metrics?: boolean,
    ): Promise<Record<string, never>>;
}

Index

Methods

create delete get list put update

Methods

create

create(
    id: string,
    rego: string,
    pretty?: boolean,
    metrics?: boolean,
): Promise<Record<string, never>>
Parameters
- id: string
- rego: string
- Optionalpretty: boolean
- Optionalmetrics: boolean
Returns Promise<Record<string, never>>
See
OPAClient.policy.put

Alias
put
- Defined in index.ts:36

delete

delete(
    id: string,
    pretty?: boolean,
    metrics?: boolean,
): Promise<Record<string, never>>
Deletes a policy module by ID.
Parameters
- id: string
  The policy module ID.
- Optionalpretty: boolean
  Format response for humans.
- Optionalmetrics: boolean
  Include compiler performance metrics.
Returns Promise<Record<string, never>>
Empty object on success.

See
https://www.openpolicyagent.org/docs/latest/rest-api/#delete-a-policy
- Defined in index.ts:54

get

get(id: string, pretty: boolean): Promise<GetPolicyResponse>
Retrieves a policy module by its ID.
Parameters
- id: string
  The policy module ID.
- pretty: boolean
  Format response for humans.
Returns Promise<GetPolicyResponse>
The policy module.

See
https://www.openpolicyagent.org/docs/latest/rest-api/#get-a-policy
- Defined in index.ts:17

list

list(): Promise<ListPoliciesResponse>
Lists all policy modules loaded into OPA.

Returns Promise<ListPoliciesResponse>
List of policy modules.

See
https://www.openpolicyagent.org/docs/latest/rest-api/#list-policies
- Defined in index.ts:9

put

put(
    id: string,
    rego: string,
    pretty?: boolean,
    metrics?: boolean,
): Promise<Record<string, never>>
Creates or updates a policy module.
Parameters
- id: string
  The policy module ID.
- rego: string
  Rego policy as plain text.
- Optionalpretty: boolean
  Format response for humans.
- Optionalmetrics: boolean
  Include compiler performance metrics.
Returns Promise<Record<string, never>>
Empty object on success.

See
https://www.openpolicyagent.org/docs/latest/rest-api/#create-or-update-a-policy
- Defined in index.ts:27

update

update(
    id: string,
    rego: string,
    pretty?: boolean,
    metrics?: boolean,
): Promise<Record<string, never>>
Parameters
- id: string
- rego: string
- Optionalpretty: boolean
- Optionalmetrics: boolean
Returns Promise<Record<string, never>>
See
OPAClient.policy.put

Alias
put
- Defined in index.ts:45

Type Alias PolicyAPI

Index

Methods

Methods

create

Parameters

Returns Promise<Record<string, never>>

See

Alias

delete

Parameters

Returns Promise<Record<string, never>>

See

get

Parameters

Returns Promise<GetPolicyResponse>

See

list

Returns Promise<ListPoliciesResponse>

See

put

Parameters

Returns Promise<Record<string, never>>

See

update

Parameters

Returns Promise<Record<string, never>>

See

Alias

Settings

On This Page