Skip to main content

Attached Security Group

GET/api/v1/security_group/{vm_id}/attach/

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 authentication

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

    Location filter for the attached security group query

    • must be a non-empty string
    • should be a valid location identifier (e.g., region code)
    example{{location}}

Responses

200Successful response
object
codeinteger

HTTP status code indicating the result of the request

example200
  • required
  • must be a valid HTTP status code (100-599)
dataarray
errorsobject
messagestring

Status message indicating the result of attaching a security group

exampleSuccess
  • must be a non-empty string
  • maximum length of 255 characters