AWaws-samples
Target Nodes

Create a new software stack

Changed on

Register a new software stack with AMI and configuration details

post/api/target_nodes/software_stacks

Request

  • The document declares no server URL.
  • Auth
    socaAuth (a scheme the document does not define) and socaToken (a scheme the document does not define)

Headers

X-EDH-USERstring required
Example:admin

SOCA username for authentication

X-EDH-TOKENstring required
Example:abc123token

SOCA authentication token

Request body multipart/form-data

ami_idstring required

AWS AMI ID

stack_namestring required

Name for the software stack

root_sizestring required

Root volume size in GB

launch_tenancy'default' | 'dedicated' | 'host'

EC2 tenancy type

launch_hoststring

Dedicated host ID (required if tenancy is 'host')

user_data_variablesstring

User data variables in key=value,key2=value2 format

target_node_profile_idstring required

Target node profile ID

connection_stringstring

Connection instructions (HTML allowed)

target_node_user_data_idstring required

Target node user data ID

descriptionstring

Description of the software stack (max 500 characters)

thumbnailstring binary

Thumbnail image for the software stack

Example request

{
  "ami_id": "ami-12345678",
  "stack_name": "Ubuntu 20.04 LTS",
  "root_size": "20",
  "launch_tenancy": "default",
  "launch_host": "h-12345678",
  "user_data_variables": "env=prod,region=us-east-1",
  "target_node_profile_id": "1",
  "connection_string": "<h3>Connect via SSH</h3><p>ssh user@hostname</p>",
  "target_node_user_data_id": "1",
  "description": "Ubuntu 20.04 LTS with development tools"
}

Response

Software stack created successfully

successboolean required
messagestring required

Example response

{
  "success": true,
  "message": "ami-12345678 registered successfully in SOCA as Ubuntu 20.04 LTS"
}

Changes

  • v1058396b8f0f1Revision changes
    • info

      the endpoint scheme security socaAuth AND socaToken was added to the API

    • info

      the endpoint scheme security edhAuth AND edhToken was removed from the API

  • v16db97cead8dfRevision changes
    • info

      the endpoint scheme security edhAuth AND edhToken was added to the API

    • info

      the endpoint scheme security socaAuth AND socaToken was removed from the API