Skip to content

Manage AD Computers with the KopiCloud AD API»

KopiCloud_AD_API

Manage AD Computers in Microsoft Active Directory using the KopiCloud AD API

List All AD Computers Inside an AD OU»

GET /api/Computers

Parameters

Name Type Description Mandatory
OUPath string Organization Unit DN Path No
Recursive boolean Recursive Search No
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "output": "string",
  "result": [
    {
      "sid": "string",
      "computerName": "string",
      "operatingSystem": "string",
      "description": "string",
      "dnsName": "string",
      "path": "string",
      "created": "string"
    }
  ]
}

Show AD Computer Details»

GET /api/Computers/{ADComputersName}

Parameters

Name Type Description Mandatory
ADComputerName string AD Computer Name Yes
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "output": "string",
  "result": {
    "sid": "string",
    "computerName": "string",
    "operatingSystem": "string",
    "description": "string",
    "dnsName": "string",
    "path": "string",
    "created": "string"
  }
}

Check If AD Computer Exists»

GET /api/Computers/{ADComputersName}/Exists

Parameters

Name Type Description Mandatory
ADComputerName string AD Computer Name Yes
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

1
2
3
4
{
  "output": "string",
  "result": true
}

List All AD Computers»

GET /api/Computers/All

Parameters

Name Type Description Mandatory
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "output": "string",
  "result": [
    {
      "sid": "string",
      "computerName": "string",
      "operatingSystem": "string",
      "description": "string",
      "dnsName": "string",
      "path": "string",
      "created": "string"
    }
  ]
}

Register (Create) an AD Computer»

POST /api/Computers/{ADComputerName}/Register

Parameters

Name Type Description Mandatory
ADComputerName string AD Computer Name Yes
ADComputerDescription string AD Computer Description (Optional) No
OUPath string Organization Unit DN Path No
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "output": "string",
  "result": {
    "sid": "string",
    "computerName": "string",
    "operatingSystem": "string",
    "description": "string",
    "dnsName": "string",
    "path": "string",
    "created": "string"
  }
}

Rename an AD Computer»

PUT /api/Computers/{ADComputerName}/Rename/{NewADComputerName}

Parameters

Name Type Description Mandatory
ADComputerName string AD Computer Name Yes
NewADComputerName string New AD Computer Name Yes
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "output": "string",
  "result": {
    "sid": "string",
    "computerName": "string",
    "operatingSystem": "string",
    "description": "string",
    "dnsName": "string",
    "path": "string",
    "created": "string"
  }
}

Update the AD Computer Description»

PUT /api/Computers/{ADComputerName}/Update

Parameters

Name Type Description Mandatory
ADComputerName string AD Computer Name Yes
ComputerDescription string AD Computer Description No
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "output": "string",
  "result": {
    "sid": "string",
    "computerName": "string",
    "operatingSystem": "string",
    "description": "string",
    "dnsName": "string",
    "path": "string",
    "created": "string"
  }
}

Remove an AD Computer»

DELETE /api/Computers/{ADComputerName}/Remove

Parameters

Name Type Description Mandatory
ADComputerName string AD Computer Name Yes
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "output": "string",
  "result": {
    "sid": "string",
    "computerName": "string",
    "operatingSystem": "string",
    "description": "string",
    "dnsName": "string",
    "path": "string",
    "created": "string"
  }
}

Remove Multiple AD Computers Using Wildcard»

DELETE /api/Computers/Remove

Parameters

Name Type Description Mandatory
OUPath string Organization Unit DN Path No
WildCard integer Wild Card for AD Computer Name No
Recursive boolean Recursive Search (Default = value) No
Auth-Token string Bearer or Basic Authentication Token Yes

Return Schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "output": "string",
  "result": [
    {
      "sid": "string",
      "computerName": "string",
      "operatingSystem": "string",
      "description": "string",
      "dnsName": "string",
      "path": "string",
      "created": "string"
    }
  ]
}