--- title: "Add instance to security group" method: POST path: "/v1/security-groups/{securityGroupId}/instances" tags: ["Security groups"] --- # Add instance to security group `POST /v1/security-groups/{securityGroupId}/instances` ## Request - Base URL: `https://api.emma.ms/external` - URL: `https://api.emma.ms/external/v1/security-groups/{securityGroupId}/instances` - Auth: HTTP bearer This method adds a compute instance to the selected security group. A security group refers to a set of rules that determine what network traffic is allowed to enter or leave a particular compute instance. It acts as a virtual firewall, controlling inbound and outbound traffic based on predefined rules. Security groups operate based on predefined rules that allow traffic based on specified criteria, such as source IP address, destination IP address, port number, and protocol. Any compute instance always uses some security group since its creation. Adding a compute instance to a security group effectively means moving it from one security group to another. When adding a compute instance to a new security group, it is automatically removed from the previous security group. ## Path parameters - `securityGroupId` integer, required ## Request body - SecurityGroupInstanceAdd - `instanceId` integer: ID of the compute instance to be added to the Security group ## Response `200` Successful operation - Vm - `id` integer: ID of the virtual machine - `createdAt` string: Date and time when the virtual machine was created - `createdByName` string: Name of the user who created the virtual machine - `createdById` integer: ID of the user who created the virtual machine - `modifiedAt` string: Date and time when the virtual machine was last edited - `modifiedByName` string: Name of the user who last edited the virtual machine - `modifiedById` integer: ID of the user who last edited the virtual machine - `name` string: Name of the virtual machine - `projectId` integer: Project ID - `status` 'POWERED_ON' | 'POWERED_OFF' | 'BUSY' | 'DRAFT' | 'FAILED_CREATION': Status of the virtual machine - `provider` object - `id` integer: ID of the cloud provider - `name` string: Name of the cloud provider - `location` object - `id` integer: ID of the data center location - `name` string: Name of the data center location (city or state) - `country` string: Country of the data center location - `continent` string: Name of the geographical continent - `region` string: Name of the geographical region - `latitude` number, double: Approximate latitude of the geographical location - `longitude` number, double: Approximate longitude of the geographical location - `dataCenter` object - `id` string: Data center ID - `name` string: Data center name - `providerId` integer: ID of the cloud provider - `providerName` string: Name of the cloud provider - `locationId` integer: ID of the data center location - `locationName` string: Name of the data center location - `os` object - `id` integer: ID of the operating system - `family` string: Family of the operating system - `architecture` string: Architecture of the operating system - `type` string: Type of the operating system - `version` string: Version of the operating system - `vCpu` integer: Number of virtual Central Processing Units (vCPUs) - `vCpuType` 'shared' | 'standard' | 'hpc': Type of virtual Central Processing Units (vCPUs) - `cloudNetworkType` 'isolated' | 'multi-cloud' | 'default': Cloud network type - `ramGb` integer: Capacity of the RAM in gigabytes - `disks` object[]: List of volumes - `id` integer: Volume ID - `sizeGb` integer: Volume size in gigabytes - `typeId` integer: ID of the volume type - `type` 'hdd' | 'ssd' | 'ssd-plus': Volume type - `isBootable` boolean: Indicates whether the volume is bootable or not - `deviceIdentifier` string, nullable: Device identifier of the volume as seen by the operating system - `localDisks` object[], nullable: Local SSD storage directly attached to the host. Data is ephemeral and will be lost when the VM is stopped or deleted. - `sizeTb` number: Volume size in TB - `typeId` integer: ID of the volume type - `type` string: Volume type - `accelerator` object, nullable: GPU accelerator - `acceleratorTypeId` string: GPU accelerator type ID - `acceleratorType` string: GPU accelerator type - `accelerators` number: Quantity of GPU accelerators - `totalGpuMemoryGb` integer: Total GPU memory (GPU) - `networks` object[] - `id` integer: Network ID - `ip` string: IPv4 or IPv6 address - `ipVersion` number: IP version - `networkTypeId` integer: ID of the network type - `networkType` string: Network type - `securityGroup` object - `id` integer: ID of the security group - `name` string: Name of the security group - `subnetwork` object - `id` string: ID of the subnetwork - `name` string: Name of the subnetwork - `sshKeyId` integer, nullable: SSH key ID - `userName` string, nullable: User name - `userPassword` string, nullable: User password - `cost` object - `unit` string: Cost period - `currency` string: Currency of cost - `price` number: Cost of the virtual machine for the period - `tags` Tag[], nullable - `tagId` string, uuid, required: tag id - `key` string, required: tag key - `value` string, nullable: tag key value - `systemKeyInstalled` boolean: Indicates whether the emma system SSH key is installed on the virtual machine - `workflowExecutionInfo` VmWorkflowExecution, nullable: Workflow execution that provisioned the virtual machine - `executionId` string, uuid: Id of the workflow execution - `workflowTemplateId` integer, nullable: Id of the workflow template that was executed; returned even after the template has been deleted - `workflowTemplateName` string: Name of the workflow template - `workflowExists` boolean: Whether the workflow template still exists; false when it was deleted, in which case clients must not render a link to the template - `status` 'PENDING' | 'RUNNING' | 'SUCCESS' | 'FAILED': Status of the workflow execution - `versionId` integer: ID of the workflow version used to create the instance - `versionName` string: Name of the workflow version used to create the instance - `versionExists` boolean: Whether the workflow version still exists; false when it was deleted, in which case clients must not render a link to the template ## Other responses - `400`: Bad request - `401`: Unauthorized - `403`: Forbidden - `404`: Not found - `422`: Unprocessable entity - `500`: Internal server error --- [API](https://skmtc.dev/emma/apis/public-emma-api.md) - [All operations](https://skmtc.dev/emma/apis/public-emma-api/llms.txt) - [OpenAPI document](https://skmtc.dev/emma/apis/public-emma-api/revisions/9e55f0920078?raw)