Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Exoscale security-group API

Security Groups are groups of firewall rules that regulate network traffic to and from your Compute instances.

Exoscale security-group API is one of 37 APIs that Exoscale publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include security-group. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and pricing.

This API exposes 10 operations across 8 paths, and defines 18 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

Requests are made against a single base URL, https://api-{zone}.exoscale.com/v2.

10 operations 8 paths 18 schemas 2 DELETE2 GET2 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Base URL
https://api-ch-gva-2.exoscale.com/v2
Terms of Service
Resource Areas
1

Paths & Operations 10

Across 8 paths, the API surfaces 10 operations — 2 DELETE, 2 GET, 2 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

security-group 10

Security Groups are groups of firewall rules that regulate network traffic to and from your Compute instances.

DELETE
/security-group/{id}/rules/{rule-id}
Delete a Security Group rule
delete-rule-from-security-group 2 params → 200
POST
/security-group
Create a Security Group
create-security-group body → 200
GET
/security-group
List Security Groups.
list-security-groups 1 param → 200
GET
/security-group/{id}
Retrieve Security Group details
get-security-group 1 param → 200
DELETE
/security-group/{id}
Delete a Security Group
delete-security-group 1 param → 200
PUT
/security-group/{id}:attach
Attach a Compute instance to a Security Group
attach-instance-to-security-group 1 param body → 200
POST
/security-group/{id}/rules
Create a Security Group rule
add-rule-to-security-group 1 param body → 200
PUT
/security-group/{id}:remove-source
Remove an external source from a Security Group
remove-external-source-from-security-group 1 param body → 200
PUT
/security-group/{id}:detach
Detach a Compute instance from a Security Group
detach-instance-from-security-group 1 param body → 200
PUT
/security-group/{id}:add-source
Add an external source as a member of a Security Group
add-external-source-to-security-group 1 param body → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are instance (25 properties), template (18 properties), security-group-rule (9 properties), instance-type (8 properties). Each schema is shown below with its type and property counts.

instance-type
object
Compute instance type
8 properties
ssh-key
object
SSH key
2 properties
labels
object
deploy-target-ref
object
Deploy target reference
1 property
security-group-ref
object
Security group reference
1 property
anti-affinity-group-ref
object
Anti-affinity group reference
1 property
security-group-rule
object
Security Group rule
9 properties
template
object
Instance template
18 properties
zone-name
string
elastic-ip-ref
object
Elastic IP reference
1 property
manager
object
Resource manager
2 properties
security-group
object
Security Group
5 properties
public-ip-assignment
string
instance-state
string
instance
object
Instance
25 properties
snapshot-ref
object
Snapshot reference
1 property
operation
object
Operation
5 properties
security-group-resource
object
Security Group
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

exoscale-security-group-api-openapi.yml Raw ↑

Other APIs Exoscale publishes across the network.

Exoscale ai-api-key API
Exoscale anti-affinity-group API
Exoscale api-key API
Exoscale block-storage API
Exoscale ccm API
Exoscale cluster API
Exoscale compute API
Exoscale crypto API
Exoscale dbaas API
Exoscale deploy-target API
Exoscale deployment API
Exoscale domain API