The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.
PUT /api/ss/group/:id HTTP/1.1Host: demo.attackforge.comX-SSAPI-KEY: APIKeyContent-Type: application/jsonConnection: close
id (string)
Id of the group.
Example:
PUT /api/ss/group/5eab99471e18050942c7607a HTTP/1.1
name (string) (optional)
Name of the group.
Example:
{"name": "..."}
group_owner (string) (optional)
Name of the owner for the group.
Example:
{"group_owner": "..."}
primary_contact_name (string) (optional)
Primary contact person name.
Example:
{"primary_contact_name": "..."}
primary_contact_number (string) (optional)
Primary contact person number.
Example:
{"primary_contact_number": "..."}
primary_contact_email (string) (optional)
Primary contact person email.
Example:
{"primary_contact_email": "..."}
is_deleted (boolean) (optional)
Whether group is deleted or not.
Example:
{"is_deleted": false}
The following example is a cURL request to create a new group.
Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
curl -X PUT 'https://demo.attackforge.com/api/ss/group/5eab99471e18050942c7607a' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{"name": "ACME Corp. Technology Team","group_owner": "John Citizen","primary_contact_name": "Paul Citizen","primary_contact_number": "(555)555-5555","primary_contact_email": "john.citizen@attackforge.com","is_deleted": false}'
Response contains a status.
{"status": "Group Updated"}