Skip to main content
POST
/
v1
/
actor
/
{ActorID}
/
machineGroups
Add Machine Group
curl --request POST \
  --url https://qa-lynx.nayax.com/operational/v1/actor/{ActorID}/machineGroups \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "MachineGroupId": 123,
  "MachineGroupName": "<string>",
  "MachineGroupCode": 123,
  "MachineGroupStatus": 1,
  "LanguageId": 2
}
'
{
  "MachineGroupId": 123,
  "ActorId": 123,
  "MachineGroupName": "<string>",
  "MachineGroupCode": 123,
  "MachineGroupStatus": 123,
  "CreatedBy": 123,
  "CreatedOn": "2023-11-07T05:31:56Z",
  "UpdatedOn": "2023-11-07T05:31:56Z",
  "UpdatedBy": 123
}

Authorizations

​
Authorization
string
header
required

Enter your API key. It's required to authenticate API requests.

Path Parameters

​
ActorID
integer<int64>
required

The unique identifier of the actor for whom the machine group is being added.

Body

application/json

The details of the machine group to be added.

Represents the data required to create or update a machine group associated with an actor.

​
MachineGroupId
integer<int32> | null

The unique identifier of the machine group. This is typically provided when updating an existing machine group.

​
MachineGroupName
string | null

The name of the machine group.

​
MachineGroupCode
integer<int64> | null

A code assigned to the machine group for identification or categorization.

​
MachineGroupStatus
enum<integer>

The status identifier of the machine group, indicating its current state.

Available options:
1,
2
​
LanguageId
enum<integer> | null

The virtual machine's language in the "General" tab.

Available options:
2,
4,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
21,
22,
23,
27,
28,
29,
30,
31,
34,
41,
42,
51,
52,
54,
62,
64,
81

Response

200 - application/json

The machine group was added successfully.

Represents the details of a machine group associated with an actor, including identification, status, and audit information.

​
MachineGroupId
integer<int32> | null

The unique identifier of the machine group.

​
ActorId
integer<int64> | null

The unique identifier of the actor associated with this machine group.

​
MachineGroupName
string | null

The name of the machine group.

​
MachineGroupCode
integer<int64> | null

A code assigned to the machine group for identification or categorization.

​
MachineGroupStatus
integer<int32>

The status identifier of the machine group, indicating its current state.

​
CreatedBy
integer<int64> | null

The unique identifier of the user who created this machine group.

​
CreatedOn
string<date-time> | null

The date and time when the machine group was created.

​
UpdatedOn
string<date-time> | null

The date and time when the machine group was last updated.

​
UpdatedBy
integer<int64> | null

The unique identifier of the user who last updated this machine group.