Create Security Rule

POST 
/projects/:projectId/providers/Aruba.Network/vpcs/:vpcId/securityGroups/:securityGroupId/securityRules

Create Security Rule

Request

Path Parameters

projectId stringrequired

unique identifier of the project CMP

vpcId stringrequired

unique identifier of the vpc in which the security group has been created

securityGroupId stringrequired

unique identifier of the security group in which the security rule will be created

Query Parameters

api-version string
The requested API version
Default value: 1.0

application/json

Body

the security rule to create

metadata

object

Metadata of the resource

namestring

Name of the resource

location

object

Contains information about the Region of a resource

valuestring

Value of the region in which the resource will be located. Available regions at present:

• ITBG-Bergamo

For more information, check the documentation.

tagsstring[]nullable

List of tags for the resource

properties

object

nullable

Properties of a security rule

directionRuleDirection (string)

Direction of the rule. Admissible values:

• Ingress
• Egress

Possible values: [Ingress, Egress]

protocolstring

Name of the protocol. Admissible values:

• ANY
• TCP
• UDP
• ICMP

portstring

Port can be set with different values, according to the protocol.

• ANY and ICMP must not have a port
• TCP and UPD can have
  • a single numeric port. For instance "80", "443" etc.
  • a port range. For instance "80-100"
  • the "*" value indicating any ports

target

object

The target of the rule (source or destination according to the direction)

kindEndpointTypeDto (string)

Type of the target. Admissibile values.

• Ip
• SecurityGroup

Possible values: [Ip, SecurityGroup]

valuestring

Value of the target. If kind = "Ip", the value must be a valid network address in CIDR notation (included 0.0.0.0/0) If kind = "SecurityGroup", the value must be a valid uri of any security group within the same vpc

text/json

Body

the security rule to create

metadata

object

Metadata of the resource

namestring

Name of the resource

location

object

Contains information about the Region of a resource

valuestring

Value of the region in which the resource will be located. Available regions at present:

• ITBG-Bergamo

For more information, check the documentation.

tagsstring[]nullable

List of tags for the resource

properties

object

nullable

Properties of a security rule

directionRuleDirection (string)

Direction of the rule. Admissible values:

• Ingress
• Egress

Possible values: [Ingress, Egress]

protocolstring

Name of the protocol. Admissible values:

• ANY
• TCP
• UDP
• ICMP

portstring

Port can be set with different values, according to the protocol.

• ANY and ICMP must not have a port
• TCP and UPD can have
  • a single numeric port. For instance "80", "443" etc.
  • a port range. For instance "80-100"
  • the "*" value indicating any ports

target

object

The target of the rule (source or destination according to the direction)

kindEndpointTypeDto (string)

Type of the target. Admissibile values.

• Ip
• SecurityGroup

Possible values: [Ip, SecurityGroup]

valuestring

Value of the target. If kind = "Ip", the value must be a valid network address in CIDR notation (included 0.0.0.0/0) If kind = "SecurityGroup", the value must be a valid uri of any security group within the same vpc

application/*+json

Body

the security rule to create

metadata

object

Metadata of the resource

namestring

Name of the resource

location

object

Contains information about the Region of a resource

valuestring

Value of the region in which the resource will be located. Available regions at present:

• ITBG-Bergamo

For more information, check the documentation.

tagsstring[]nullable

List of tags for the resource

properties

object

nullable

Properties of a security rule

directionRuleDirection (string)

Direction of the rule. Admissible values:

• Ingress
• Egress

Possible values: [Ingress, Egress]

protocolstring

Name of the protocol. Admissible values:

• ANY
• TCP
• UDP
• ICMP

portstring

Port can be set with different values, according to the protocol.

• ANY and ICMP must not have a port
• TCP and UPD can have
  • a single numeric port. For instance "80", "443" etc.
  • a port range. For instance "80-100"
  • the "*" value indicating any ports

target

object

The target of the rule (source or destination according to the direction)

kindEndpointTypeDto (string)

Type of the target. Admissibile values.

• Ip
• SecurityGroup

Possible values: [Ip, SecurityGroup]

valuestring

Value of the target. If kind = "Ip", the value must be a valid network address in CIDR notation (included 0.0.0.0/0) If kind = "SecurityGroup", the value must be a valid uri of any security group within the same vpc

Responses

201

Created

text/plain

Schema

Schema

metadata

object

nullable

idstringnullable

uristringnullable

namestringnullable

location

object

nullable

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

nullable

idstringnullable

tagsstring[]nullable

category

object

nullable

namestringnullable

providerstringnullable

typology

object

nullable

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

status

object

nullable

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

nullable

isDisabledboolean

reasonsstring[]nullable

previousStatus

object

nullable

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

nullable

linkedResources

object[]

nullable

Array [

uristringnullable

strictCorrelationboolean

]

directionstringnullable

Direction of the rule.

protocolstringnullable

Protocol

portstringnullable

Port range

target

object

nullable

The target of the rule (source or destination according to the direction)

kindEndpointTypeDto (string)nullable

Type of the target.

Possible values: [Ip, SecurityGroup]

valuestringnullable

Value of the target.

data

object

nullable

private

object

nullable

unremovableboolean

Example (from schema)

{}

application/json

Schema

Schema

metadata

object

nullable

idstringnullable

uristringnullable

namestringnullable

location

object

nullable

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

nullable

idstringnullable

tagsstring[]nullable

category

object

nullable

namestringnullable

providerstringnullable

typology

object

nullable

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

status

object

nullable

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

nullable

isDisabledboolean

reasonsstring[]nullable

previousStatus

object

nullable

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

nullable

linkedResources

object[]

nullable

Array [

uristringnullable

strictCorrelationboolean

]

directionstringnullable

Direction of the rule.

protocolstringnullable

Protocol

portstringnullable

Port range

target

object

nullable

The target of the rule (source or destination according to the direction)

kindEndpointTypeDto (string)nullable

Type of the target.

Possible values: [Ip, SecurityGroup]

valuestringnullable

Value of the target.

data

object

nullable

private

object

nullable

unremovableboolean

Example (from schema)

{}

text/json

Schema

Schema

metadata

object

nullable

idstringnullable

uristringnullable

namestringnullable

location

object

nullable

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

nullable

idstringnullable

tagsstring[]nullable

category

object

nullable

namestringnullable

providerstringnullable

typology

object

nullable

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

status

object

nullable

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

nullable

isDisabledboolean

reasonsstring[]nullable

previousStatus

object

nullable

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

nullable

linkedResources

object[]

nullable

Array [

uristringnullable

strictCorrelationboolean

]

directionstringnullable

Direction of the rule.

protocolstringnullable

Protocol

portstringnullable

Port range

target

object

nullable

The target of the rule (source or destination according to the direction)

kindEndpointTypeDto (string)nullable

Type of the target.

Possible values: [Ip, SecurityGroup]

valuestringnullable

Value of the target.

data

object

nullable

private

object

nullable

unremovableboolean

Example (from schema)

{}

400

Bad Request

text/plain

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

Server Error