Skip to main content

Detach Security Group

POST/api/v1/security_group/{vm_id}/detach/

Path parameters

  • vm_idPathstringrequired

    Path parameter vm_id.

Query parameters

  • project_idQuerystringoptional

    Identifier of the project to scope the request to. Optional; if omitted, the account's default project is used.

    • optional
    • if omitted, the request is applied to the default project
    example{{project_id}}
  • apikeyQuerystringoptional

    API key used for authenticating the request

    • required
    • must be a valid API key string
    example{{api_key}}
  • locationQuerystringoptional

    E2E Myaccount region identifier for the request

    • required
    • must be a valid E2E Myaccount location string (e.g., "eastus")
    example{{location}}

Request body

application/json

string

JSON-formatted string containing the security_group_ids to detach

example{ "security_group_ids": [ {{security_group_id}} ] }
  • must be a valid JSON string
  • must include a "security_group_ids" field
  • "security_group_ids" must be an array of security group ID strings
  • array should not be empty

Responses

200Successful response
object
codeinteger

HTTP status code indicating the result of the detach operation

example200
  • must be a valid HTTP status code
  • typically 200 for success
dataobject
errorsobject
messagestring

Human-readable status message for the detach security group operation

exampleSecurity Groups Detached Successfully
  • must be a non-empty string
  • maximum length of 255 characters