This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Create AccessControl

1 - 1.3

scpcli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

Create access control

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
stringAccess Control NameDenyTest
connected_stages
required
arrayConnected Stagesdev,stg
allowed_ip_addr
required
arrayAllowed IP Address127.0.0.1/24,192.168.127.12
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

2 - 1.2

scpcli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

Create access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
stringAccess Control NameDenyTest
connected_stages
required
arrayConnected Stagesdev,stg
allowed_ip_addr
required
arrayAllowed IP Address127.0.0.1/24,192.168.127.12
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

3 - 1.1

scpcli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

Create access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
stringAccess Control NameDenyTest
connected_stages
required
arrayConnected Stagesdev,stg
allowed_ip_addr
required
arrayAllowed IP Address127.0.0.1/24,192.168.127.12
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest

4 - 1.0

scpcli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

Create access control

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
stringAccess Control NameDenyTest
connected_stages
required
arrayConnected Stagesdev,stg
allowed_ip_addr
required
arrayAllowed IP Address127.0.0.1/24,192.168.127.12
description
optional
stringDescriptiondescription

Responses

NameDescriptionExample
idAccess Control ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addrAllowed IP Address[‘127.0.0.1/24,192.168.127.12’]
connected_stagesConnected Stages[‘dev,stg’]
created_atCreation Date2024-05-19T00:23:17Z
descriptionDescription
nameAccess Control NameDenyTest