Set Vm Egress Policy

POST /v1/egress/vm/{vm_id}

Authentication

Requires authentication via: OAuth2PasswordBearer.

Parameters

Name	In	Type	Required	Description	Constraints
vm_id	path	string	Yes
X-API-Key	header	string | null	No		nullable

Request Body

Required: Yes

application/json

Resolved schema:

{
  "properties": {
    "allow_public_repos": {
      "type": "boolean",
      "title": "Allow Public Repos",
      "default": true
    },
    "allow_http": {
      "type": "boolean",
      "title": "Allow Http",
      "default": true
    },
    "allow_https": {
      "type": "boolean",
      "title": "Allow Https",
      "default": true
    },
    "allowed_domains": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Allowed Domains"
    },
    "allowed_cidrs": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Allowed Cidrs"
    }
  },
  "type": "object",
  "title": "EgressPolicyRequest"
}

Field details:

Field	Type	Required	Description	Constraints
allow_public_repos	boolean	No		default=true
allow_http	boolean	No		default=true
allow_https	boolean	No		default=true
allowed_domains	array<string>	No
allowed_domains[]	string	No
allowed_cidrs	array<string>	No
allowed_cidrs[]	string	No

Responses

200

Successful Response

application/json

Resolved schema:

{}

422

Validation Error

application/json

Resolved schema:

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

Field details:

Field	Type	Required	Description	Constraints
detail	array<object>	No
detail[]	object	No
detail[].loc	array<string | integer>	No
detail[].loc[]	string | integer	No
detail[].msg	string	No
detail[].type	string	No