Shield chevron_right Deployment

Deploy Shield

Initializes a new security perimeter within the AEGIS network. This endpoint creates a logically isolated shield instance tailored to the specified protocol requirements.

POST /v1/shield/deploy

key Headers

Field	Type	Description
Authorization	string	Bearer token required for API access.
X-Aegis-Cluster	string	Optional cluster identifier for region pinning.

description Body Parameters

shield_name Required string

A unique identifier for the shield instance.

protocol_type Required string

Specifies the defense layer. Options: quantum, standard, legacy.

auto_scaling boolean

Enable automated compute adjustments based on load. Defaults to true.

Example Request

curl --request POST \
  --url https://api.aegis.io/v1/shield/deploy \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "shield_name": "alpha-secure-01",
    "protocol_type": "quantum",
    "auto_scaling": true
  }'

Example Response

201 Created

{
  "status": "success",
  "data": {
    "shield_id": "sh_01GZH8",
    "deployment_id": "dep_992120",
    "endpoint": "alpha-secure-01.shield.aegis.io",
    "created_at": "2023-10-24T14:32:01Z",
    "config": {
      "auto_scaling": true,
      "zones": ["us-east-1", "eu-central-1"]
    }
  }
}

warning Common Errors

401: Invalid or expired authorization token.
409: Shield name already exists in current cluster.