ApiGateway¶

Gateway Operations¶

class otcextensions.sdk.apig.v2._proxy.Proxy(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)

gateways(**attrs)

Query gateways

Returns:: A generator of gateway object of a Gateway

create_gateway(**attrs)

Create gateway

Returns:: A gateway object
Return type:: Gateway

wait_for_gateway(gateway, status='Running', failures=None, interval=2, wait=960)

Wait for specific gateway status :param gateway: key id or an instance of Gateway

Parameters:

status – Specific status of the gateway.
failures – Specific failure status of the gateway.
interval – Seconds between checking the gateway.
wait – Seconds between checking the gateway.

%returns: instance of: Gateway

get_gateway(gateway)

Get details of specific gateway :param gateway: key id or an instance of Gateway

Returns:: instance of Gateway

update_gateway(gateway, **attrs)

Update an existing API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – The attributes to update on the gateway.

Returns:

Updated instance of Gateway

delete_gateway(gateway, **attrs)

Delete specific gateway :param gateway: key id or an instance of Gateway

Returns:: ‘None’

get_gateway_progress(gateway)

Get specific gateway progress :param gateway: key id or an instance of Gateway

%returns: instance of: Gateway

get_constraints(gateway)

Get gateway constraints

Parameters:: gateway – key id or an instance of Gateway

%returns: instance of: Gateway

enable_public_access(gateway, **attrs)

Enable public access for a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional attributes to configure public access.

Returns:

Updated instance of Gateway

update_public_access(gateway, **attrs)

Update public access settings for a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – The attributes to update public access settings.

Returns:

Updated instance of Gateway

disable_public_access(gateway)

Disable public access for a specific API Gateway.

Parameters:: gateway – The ID of the gateway or an instance of Gateway
Returns:: Updated instance of Gateway

modify_gateway_spec(gateway, **attrs)

Modify the specifications of a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – The attributes to modify the gateway specifications.

Returns:

Updated instance of Gateway

bind_eip(gateway, **attrs)

Bind an Elastic IP (EIP) to a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – The attributes required for binding the EIP.

Returns:

Updated instance of Gateway

unbind_eip(gateway)

Unbind an Elastic IP (EIP) from a specific API Gateway.

Parameters:: gateway – The ID of the gateway or an instance of Gateway
Returns:: Updated instance of Gateway

enable_ingress(gateway, **attrs)

Enable public inbound access for a specific API Gateway.

This method binds a public IP to an API Gateway to allow public inbound traffic from the internet.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional attributes required for enabling public inbound access

Returns:

Updated instance of Gateway

update_ingress(gateway, **attrs)

Update public inbound access bandwidth of a specific API Gateway.

This method modifies the inbound bandwidth settings for an API Gateway that has public access enabled.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional attributes required for updating the ingress bandwidth

Returns:

Updated instance of Gateway

disable_ingress(gateway)

Disable public inbound access for a specific API Gateway.

This method removes public inbound access from an API Gateway by unbinding the associated public IP.

Parameters:: gateway – The ID of the gateway or an instance of Gateway
Returns:: Updated instance of Gateway

AZ Operations¶

azs(**attrs)

Retrieve availability zones (AZs) for API Gateway service.

Parameters:: attrs – Optional filters for querying availability zones.
Returns:: A list of availability zones.
Return type:: list of AZ

Environment Operations¶

create_environment(gateway, **attrs)

Create a new environment for a specific API Gateway.

This method creates an environment within the given API Gateway by associating it with the specified attributes.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional attributes for the environment creation.

Returns:

An instance of ApiEnvironment

update_environment(gateway, environment, **attrs)

Update an existing environment for a specific API Gateway.

This method updates the specified environment within the API Gateway by applying the provided attributes.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
environment – The ID of the environment or an instance of ApiEnvironment
attrs – Additional attributes to update the environment.

Returns:

Updated instance of ApiEnvironment

delete_environment(gateway, environment, **attrs)

Delete an existing environment from a specific API Gateway.

This method removes the specified environment from the API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
environment – The ID of the environment or an instance of ApiEnvironment
attrs – Additional attributes for the delete operation.

Returns:

None

environments(gateway, **attrs)

List all environments for a specific API Gateway.

This method retrieves a list of environments associated with the given API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional filters for listing environments.

Returns:

A list of instances of ApiEnvironment

Api Group Operations¶

create_api_group(gateway, **attrs)

Create a new API group for a specific API Gateway.

This method creates an API group associated with the given API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional attributes for creating the API group.

Returns:

An instance of ApiGroup

update_api_group(gateway, api_group, **attrs)

Update an existing API group for a specific API Gateway.

This method updates the attributes of an API group associated with the given API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
api_group – The ID of the API group or an instance of ApiGroup
attrs – Additional attributes for updating the API group.

Returns:

The updated instance of ApiGroup

delete_api_group(gateway, api_group, **attrs)

Delete an API group from a specific API Gateway.

This method deletes the specified API group associated with the given API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
api_group – The ID of the API group or an instance of ApiGroup
attrs – Additional parameters for deleting the API group.

Returns:

None

get_api_group(gateway, api_group)

Retrieve details of a specific API group.

This method retrieves the details of an API group associated with the given API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
api_group – The ID of the API group or an instance of ApiGroup

Returns:

An instance of ApiGroup

Environment Variables Operations¶

create_environment_variable(gateway, **attrs)

Create a new environment variable for a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional attributes for the environment variable creation.

Returns:

An instance of ApiEnvironmentVar

update_environment_variable(gateway, var, **attrs)

Update an existing environment variable for a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
var – The ID of the environment var or an instance of ApiEnvironmentVar
attrs – Additional attributes to update the environment.

Returns:

Updated instance of ApiEnvironmentVar

delete_environment_variable(gateway, var, ignore_missing=False)

Delete an existing environment variable from a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
var – The ID of the environment or an instance of ApiEnvironmentVar

Returns:

None

environment_variables(gateway, **attrs)

List all environment vars for a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional filters for listing environment vars.

Returns:

A list of instances of ApiEnvironmentVar

get_environment_variable(gateway, var)

Retrieve details of a specific environment variable.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
var – The ID of the variable or an instance of ApiEnvironmentVar

Returns:

An instance of ApiEnvironmentVar

Throttling Policies Operations¶

create_throttling_policy(gateway, **attrs)

Create a new throttling policy for a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional attributes for the throttling policy creation.

Returns:

An instance of ThrottlingPolicy

update_throttling_policy(gateway, policy, **attrs)

Update an existing throttling policy for a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
tp – The ID of the throttling policy or an instance of ThrottlingPolicy
attrs – Additional attributes to update the throttling policy.

Returns:

Updated instance of ThrottlingPolicy

delete_throttling_policy(gateway, policy, ignore_missing=False)

Delete an existing throttling policy from a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
policy – The ID of the throttling policy or an instance of ThrottlingPolicy

Returns:

None

throttling_policies(gateway, **attrs)

List all throttling policies for a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional filters for listing throttling policies.

Returns:

A list of instances of ThrottlingPolicy

get_throttling_policy(gateway, policy)

Retrieve details of a specific throttling policy.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
policy – The ID of the throttling policy or an instance of ThrottlingPolicy

Returns:

An instance of ThrottlingPolicy

bind_throttling_policy(gateway, **attrs)

Bind a throttling policy to a specific API.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional attributes for the ThrottlingPolicy bind.

Returns:

An instance of ThrottlingPolicyBind

unbind_throttling_policy(gateway, bind, ignore_missing=False)

Unbind a bound Signature from a specific API.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
bind – The ID of the SignatureBind or an instance of ThrottlingPolicyBind

Returns:

None

unbind_throttling_policies(gateway, throttle_bindings: list)

Unbind a bound Signature from a specific API.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
throttle_bindings – The IDs of the request throttling policy binding records to be canceled.

Returns:

None

bound_throttling_policy_apis(gateway, **query)

List all APIs to which a specified request: throttling policy has been bound.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
query – Additional filters for listing ThrottlingPolicyBind.

Returns:

A list of instances of ThrottlingPolicyBind

not_bound_throttling_policy_apis(gateway, **query)

List all APIs to which a request throttling: policy has not been bound.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
query – Additional filters for listing NotBoundApi.

Returns:

A list of instances of NotBoundApi

bound_throttling_policies(gateway, **query)

List all throttling policies that have been bound to an API.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
query – Additional filters for listing BoundApi.

Returns:

A list of instances of BoundThrottles

Api Operations¶

create_api(gateway, **attrs)

Create a new API for a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional attributes for the Api creation.

Returns:

An instance of Api

update_api(gateway, api, **attrs)

Update an existing API for a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
api – The ID of the Api or an instance of Api
attrs – Additional attributes to update the Api.

Returns:

Updated instance of Api

delete_api(gateway, api, ignore_missing=False)

Delete an existing API from a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
api – The ID of the Api or an instance of Api

Returns:

None

apis(gateway, **attrs)

List all APIs for a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional filters for listing Api.

Returns:

A list of instances of Api

get_api(gateway, api)

Retrieve details of a specific API.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
api – The ID of the Api or an instance of Api

Returns:

An instance of Api

publish_api(gateway, env, api, **attrs)

Publish an API.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
api – The ID of the Api or an instance of Api
env – The ID of the Environment or an instance of it
attrs – Additional attributes

Returns:

An instance of PublishApi

offline_api(gateway, env, api, **attrs)

Take API offline.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
api – The ID of the Api or an instance of Api
env – The ID of the Environment or an instance of it
attrs – Additional attributes

Returns:

An instance of PublishApi

check_api(gateway, **attrs)

Verify the API definition.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional attributes

Returns:

An instance of CheckApi

debug_api(gateway, api, **attrs)

Debug an API in a specified environment.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
api – The ID of the Api or an instance of Api
attrs – Additional attributes

Returns:

An instance of DebugApi

publish_apis(gateway, env, **attrs)

Publish an APIs.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
env – The ID of the Environment or an instance of it
attrs – Additional attributes

Returns:

An instance of PublishApis

offline_apis(gateway, env, **attrs)

Takes offline an APIs.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
env – The ID of the Environment or an instance of it
attrs – Additional attributes

Returns:

An instance of PublishApis

api_versions(gateway, api)

Retrieve the historical versions of an API.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
api – The ID of the Api or an instance of Api

Returns:

An instance of PublishApis

switch_version(gateway, api, version_id)

Switch the version of an API.

Parameters:

version_id – API version ID.
gateway – The ID of the gateway or an instance of Gateway
api – The ID of the Api or an instance of Api

Returns:

An instance of PublishApis

api_runtime_definitions(gateway, api, **query)

Retrieve the runtime definition of an API.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
api – The ID of the Api or an instance of Api

Returns:

An instance of RuntimeDefinitionApi

api_version_details(gateway, version_id)

Retrieve the details of specified API version.

Parameters:

version_id – API version.
gateway – The ID of the gateway or an instance of Gateway

Returns:

An instance of RuntimeDefinitionApi

take_api_version_offline(gateway, version_id, ignore_missing=False)

Remove an effective version of an API.

Parameters:

version_id – API version.
gateway – The ID of the gateway or an instance of Gateway

Returns:

None

Credentials Operations¶

create_app(gateway, **attrs)

Create a new identity for accessing a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional attributes for the App creation.

Returns:

An instance of App

get_app(gateway, app)

Retrieve details of a specific App.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
app – The ID of the App or an instance of App

Returns:

An instance of App

update_app(gateway, app, **attrs)

Update an existing App for a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
app – The ID of the App or an instance of App
attrs – Additional attributes to update the App.

Returns:

Updated instance of App

delete_app(gateway, app, ignore_missing=False)

Delete an existing identity from a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
app – The ID of the App or an instance of App

Returns:

None

apps(gateway, **attrs)

Retrieve the list of Apps for a specific API Gateway.

Parameters:: gateway – The ID of the gateway or an instance of Gateway
Returns:: An instance of App

verify_app(gateway, app)

Verify if the App exists

Parameters:

gateway – The ID of the gateway or an instance of Gateway
app – The ID of the App or an instance of App

Returns:

An instance of App

reset_app_secret(gateway, app, **attrs)

Reset the App secret

Parameters:

gateway – The ID of the gateway or an instance of Gateway
app – The ID of the App or an instance of App
attrs – Additional attributes to update the App secret.

Returns:

An instance of App

get_app_code(gateway, app, app_code)

Retrieve details of a specific application code.

This method retrieves the details of an application code associated with the given API Gateway and application.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
app – The ID of the application or an instance of App
app_code – The ID of the application code or an instance of AppCode

Returns:

An instance of AppCode

create_app_code(gateway, app, **attrs)

Create a new application code for a specific application.

This method creates an application code associated with the given API Gateway and application.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
app – The ID of the application or an instance of App
attrs – Additional attributes for creating the application code.

Returns:

An instance of AppCode

generate_app_code(gateway, app, **attrs)

Generate a new application code for a specific application.

This method generates a new application code associated with the given API Gateway and application.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
app – The ID of the application or an instance of App
attrs – Additional attributes for generating the app code.

Returns:

An instance of AppCode

app_codes(gateway, app, **attrs)

List all application codes for a specific application.

This method retrieves a list of application codes associated with the given API Gateway and application.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
app – The ID of the application or an instance of App
attrs – Additional filters for listing application codes.

Returns:

A list of instances of AppCode

delete_app_code(gateway, app, app_code, ignore_missing=False)

Delete a specific application code.

This method deletes an application code associated with the given API Gateway and application.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
app – The ID of the application or an instance of App
app_code – The ID of the application code or an instance of AppCode
ignore_missing – When set to True, no exception will be raised if the application code does not exist. Default is False.

Returns:

None

quotas(gateway, app, **attrs)

Retrieve quotas associated with a credential.

This method retrieves the quota details associated with the given API Gateway instance and application.

Parameters:

gateway – The ID of the API Gateway instance or an instance of Instance
app – The ID of the application or an instance of App
attrs – Additional filters for retrieving quota details.

Returns:

An instance of Quota

Signature Key Operations¶

create_signature(gateway, **attrs)

Create a new Signature for a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional attributes for the Signature creation.

Returns:

An instance of Signature

update_signature(gateway, sign, **attrs)

Update an existing Signature for a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
sign – The ID of the Signature or an instance of Signature
attrs – Additional attributes to update the Signature.

Returns:

Updated instance of Signature

delete_signature(gateway, sign, ignore_missing=False)

Delete an existing Signature from a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
sign – The ID of the Signature or an instance of Signature

Returns:

None

signatures(gateway, **attrs)

List all Signatures for a specific API Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional filters for listing Signature.

Returns:

A list of instances of Signature

bind_signature(gateway, **attrs)

Bind a Signature for a specific API.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional attributes for the Signature bind.

Returns:

An instance of SignatureBind

unbind_signature(gateway, bind, ignore_missing=False)

Unbind a bound Signature from a specific API.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
bind – The ID of the SignatureBind or an instance of SignatureBind

Returns:

None

bound_signatures(gateway, **query)

List all Signatures bound a specific API.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
query – Additional filters for listing SignatureBind.

Returns:

A list of instances of SignatureBind

not_bound_apis(gateway, **query)

List all APIs to which a signature key has not been bound.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
query – Additional filters for listing NotBoundApi.

Returns:

A list of instances of NotBoundApi

bound_apis(gateway, **query)

List all APIs to which a signature key has been bound.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
query – Additional filters for listing BoundApi.

Returns:

A list of instances of BoundApi

Excluded Request Throttling Configuration¶

create_throttling_excluded_policy(gateway, policy, **attrs)

Creating an Excluded Request Throttling Configuration.

Parameters:

policy – The ID of the throttling policy or an instance of ThrottlingPolicy
gateway – The ID of the gateway or an instance of Gateway
attrs – Additional attributes for the excluded throttling policy creation.

Returns:

An instance of ThrottlingExcludedPolicy

update_throttling_excluded_policy(gateway, policy, exclude, **attrs)

Update an Excluded Request Throttling Configuration.

Parameters:

exclude – The ID of the excluded throttling policy or an instance of ThrottlingExcludedPolicy
policy – The ID of the throttling policy or an instance of ThrottlingPolicy
gateway – The ID of the gateway or an instance of Gateway
attrs – Additional attributes to update the excluded throttling policy.

Returns:

Updated instance of ThrottlingExcludedPolicy

delete_throttling_excluded_policy(gateway, policy, exclude, ignore_missing=False)

Deleting an Excluded Request Throttling Configuration.

Parameters:

exclude – The ID of the excluded throttling policy or an instance of ThrottlingExcludedPolicy
policy – The ID of the throttling policy or an instance of ThrottlingPolicy
gateway – The ID of the gateway or an instance of Gateway

Returns:

None

throttling_excluded_policies(gateway, policy, **query)

List all Excluded Request Throttling Configurations.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
policy – The ID of the throttling policy or an instance of ThrottlingPolicy
query – Additional filters for listing excluded throttling policies.

Returns:

A list of instances of ThrottlingExcludedPolicy

Gateway Features Operations¶

configure_gateway_feature(gateway, **attrs)

Configuring a feature for a Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
attrs – Additional attributes for the GatewayFeatures.

Returns:

An instance of GatewayFeatures

gateway_features(gateway, **query)

List all Gateway Features.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
query – Additional filters for listing GatewayFeatures.

Returns:

A list of instances of GatewayFeatures

supported_gateway_features(gateway, **query)

List all the supported features of a Gateway.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
query – Additional filters for listing GatewayFeatures.

Returns:

A list of instances of features names

Resource Query Operations¶

get_api_quantities(gateway)

Get the number of APIs that have been published in the RELEASE: environment and the number of APIs that have not been published in this environment.

Parameters:: gateway – The ID of the gateway or an instance of Gateway
Returns:: An instance of ApiQuantities

get_api_group_quantities(gateway)

Get the number of API groups.

Parameters:: gateway – The ID of the gateway or an instance of Gateway
Returns:: An instance of ApiGroupQuantities

get_app_quantities(gateway)

Get the number of apps that have been authorized to access APIs: and the number of apps that have not been authorized to access any APIs.

Parameters:: gateway – The ID of the gateway or an instance of Gateway
Returns:: An instance of AppQuantities

Domain Name Operations¶

bind_domain_name(gateway, group, **attrs)

Bind domain name to group.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
group – The ID of the group or an instance of ApiGroup
attrs – Additional attributes for the DomainName.

Returns:

An instance of DomainName

unbind_domain_name(gateway, group, domain, ignore_missing=False)

Unbind domain name from group.

Parameters:

domain – The ID of the gateway or an instance of DomainName
gateway – The ID of the gateway or an instance of Gateway
group – The ID of the group or an instance of ApiGroup

Returns:

None

update_domain_name_bound(gateway, group, domain, **attrs)

Update a bound of domain name to group.

Parameters:

domain – The ID of the gateway or an instance of DomainName
gateway – The ID of the gateway or an instance of Gateway
group – The ID of the group or an instance of ApiGroup
attrs – Additional attributes to update the DomainName bind.

Returns:

Updated instance of DomainName

create_certificate_for_domain_name(gateway, group, domain, **attrs)

Add certificate to domain name.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
group – The ID of the group or an instance of ApiGroup
domain – The ID of the gateway or an instance of DomainName
attrs – Additional attributes for the DomainName.

Returns:

An instance of Certificate

unbind_certificate_from_domain_name(gateway, group, domain, certificate, ignore_missing=False)

Unbind certificate from domain name.

Parameters:

certificate – The ID of the gateway or an instance of Certificate
domain – The ID of the gateway or an instance of DomainName
gateway – The ID of the gateway or an instance of Gateway
group – The ID of the group or an instance of ApiGroup
group – The ID of the certificate

Returns:

None

enable_debug_domain_name(gateway, group, domain, enable)

Disable or Enable the debugging domain name bound to an API group.

Parameters:

gateway – The ID of the gateway or an instance of Gateway
group – The ID of the group or an instance of ApiGroup
domain – The ID of the gateway or an instance of DomainName
enable – Specifies whether the debugging domain name is accessible. Options: true and false.

Returns:

An instance of DomainDebug

get_bound_certificate(gateway, group, domain, certificate)

Get the details of the certificate bound to a domain name.

Parameters:

certificate – The ID of the gateway or an instance of Certificate
gateway – The ID of the gateway or an instance of Gateway
group – The ID of the group or an instance of ApiGroup
domain – The ID of the gateway or an instance of DomainName

Returns:

An instance of Certificate

Certificate Operations¶

delete_certificate(certificate, ignore_missing=False)

Delete an SSL certificate.

Parameters:: certificate – The ID of the gateway or an instance of Certificate
Returns:: None

App Authorization Operations¶

list_api_bound_to_app(gateway, **attrs)

List all APIs authorized (bound) to a specific application.

This method retrieves a list of APIs that are bound (authorized) to the given application within the specified API Gateway instance.

Parameters:

gateway – The ID of the API Gateway instance or an instance of Instance
attrs – Additional filters, such as app_id, env_id, or API name.

Returns:

A list of instances of ApiAuthInfo

list_apps_bound_to_api(gateway, **attrs)

List all applications authorized (bound) to a specific API.

This method gets a list of applications that are bound (authorized) to the given API within the specified API Gateway instance.

Parameters:

gateway – The ID of the API Gateway instance or an instance of Instance
attrs – Additional filters, such as api_id or environment ID.

Returns:

A list of instances of ApiAuthInfo

list_api_not_bound_to_app(gateway, **attrs)

List all APIs not authorized (not bound) to a specific application.

This method retrieves a list of APIs that are not bound (unauthorized) to the given application within the specified API Gateway instance.

Parameters:

gateway – The ID of the API Gateway instance or an instance of Instance
attrs – Additional filters, such as app_id or environment ID.

Returns:

A list of instances of ApiAuth

create_auth_in_api(gateway, **attrs)

Authorize one or more applications to access a specific API.

This method binds applications to the specified API within the given API Gateway instance, effectively authorizing them to access the API.

Parameters:

gateway – The ID of the API Gateway instance or an instance of Instance
attrs – Attributes required for authorization, including: - api_id: ID of the API to authorize. - app_ids: List of application IDs to bind to the API. - env_id: ID of the environment in which the API is published.

Returns:

An instance of ApiAuthInfo

delete_auth_from_api(gateway, auth_id)

Delete an API authorization from an application.

This method removes the authorization binding between a specific API and an application within the given API Gateway instance.

Parameters:

gateway – The ID of the API Gateway instance or an instance of Instance
auth_id – The ID of the authorization binding to be deleted.

Returns:

None

Access Control Policy Operations¶

class otcextensions.sdk.apig.v2._proxy.Proxy(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)

last updated: UTC - commit: