Class NetworkAclsClient

Index

Constructors

constructor

new NetworkAclsClient(options: BaseClientOptions): NetworkAclsClient
Parameters
- options: BaseClientOptions
Returns NetworkAclsClient

Methods

list

list(
requestOptions?: NetworkAclsClient.RequestOptions,
): HttpResponsePromise<GetAllKeysNetworkAclsResponseContent>
Retrieve all keys used to verify HTTP Message Signatures on Network ACL rules, ordered by creation time descending.
Parameters
- OptionalrequestOptions: NetworkAclsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetAllKeysNetworkAclsResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.keys.networkAcls.list()
```

create

create(
request: CreateKeysNetworkAclsRequestContent,
requestOptions?: NetworkAclsClient.RequestOptions,
): HttpResponsePromise<CreateKeysNetworkAclsResponseContent>
Create a new key used to verify HTTP Message Signatures on Network ACL rules.
Parameters
- request: CreateKeysNetworkAclsRequestContent
- OptionalrequestOptions: NetworkAclsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateKeysNetworkAclsResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.keys.networkAcls.create({
        name: "name",
        alg: "hmac-sha256",
        value: "value"
    })
```

get

get(
id: string,
requestOptions?: NetworkAclsClient.RequestOptions,
): HttpResponsePromise<NetworkAclKey>
Retrieve a specific key used to verify HTTP Message Signatures on Network ACL rules.
Parameters
- id: string
  ID of the Network ACL Key to retrieve.
- OptionalrequestOptions: NetworkAclsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<NetworkAclKey>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.keys.networkAcls.get("id")
```

delete

delete(
id: string,
requestOptions?: NetworkAclsClient.RequestOptions,
): HttpResponsePromise<void>
Delete a key used to verify HTTP Message Signatures on Network ACL rules
Parameters
- id: string
  ID of the Network ACL Key to delete.
- OptionalrequestOptions: NetworkAclsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.keys.networkAcls.delete("id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class NetworkAclsClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns NetworkAclsClient

Methods

list

Parameters

Returns HttpResponsePromise<GetAllKeysNetworkAclsResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateKeysNetworkAclsResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<NetworkAclKey>

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Settings

On This Page

`Protected` `Readonly`_options