API Endpoints: Beta-only

Note: The following endpoints are only in beta.

POST /computers/<computer_id>/archive

Archives the selected computer after it has been manually sanitized.

Path parameters:

  • computer_id: An ID assigned to a specific computer.

Required parameters:

  • computer_title: Confirm the name of the computer to archive

Example request:

curl -X POST "https://landscape.canonical.com/api/v2/computers/29/archive" -H "Authorization: Bearer $JWT" -d '{"computer_title": "test computer"}'

Example output:

{
 "id": 124,
 "activity_status": "succeeded",
 "approval_time": null,
 "completion_time": "2025-02-22T02:14:19Z",
 "creation_time": "2025-02-22T02:14:19Z",
 "creator": {
     "email": "john@example.com",
     "id": 1,
     "name": "John Smith"
 },
 "deliver_delay_window": 0,
 "parent_id": null,
 "result_code": null,
 "result_text": null,
 "summary": "Archive computer",
 "type": "ActivityGroup"
}

POST /computers/<computer_id>/delete-children

Creates an activity to delete WSL instances on a Windows host. The WSL instance does not have to be managed in Landscape.

Required parameters:

  • computer_names

Example request:

curl -X POST https://landscape.canonical.com/api/v2/computers/20/delete-children -H "Authorization: Bearer $JWT" -d '{"computer_names": ["Ubuntu-24.04", "Focal WSL"]}'

Example output:

{
  "id": 119,
  "creation_time": "2025-02-22T02:03:26Z",
  "creator": {
    "email": "john@example.com",
    "id": 1,
    "name": "John Smith"
  },
  "summary": "Deleting child computer(s)",
  "type": "ActivityGroup",
  "deliver_delay_window": 0,
  "approval_time": null,
  "completion_time": null,
  "parent_id": null,
  "result_code": null,
  "result_text": null,
  "activity_status": "undelivered"
}

POST /computers/<computer_id>/sanitize

Note: Please make sure you are sanitizing the correct computer. This action is irreversible.

Sanitizes the selected computer. This action will make the data on the selected computer permanently irrecoverable by erasing the keyslots of every encrypted volume. A configurable delay can be set in the service.conf file.

Path parameters:

  • computer_id: An ID assigned to a specific computer.

Required parameters:

  • computer_title: Confirm the name of the computer to sanitize

Example request:

curl -X POST "https://landscape.canonical.com/api/v2/computers/29/sanitize" -H "Authorization: Bearer $JWT" -d '{"computer_title": "test computer"}'

Example output:

{
 "id": 119,
 "activity_status": "scheduled",
 "approval_time": null,
 "completion_time": null,
 "creation_time": "2025-01-07T05:27:39Z",
 "creator": {
     "email": "john@example.com",
     "id": 1,
     "name": "John Smith"
 },
 "deliver_delay_window": 0,
 "parent_id": null,
 "result_code": null,
 "result_text": null,
 "summary": "Sanitizing computer",
 "type": "ActivityGroup"
}

POST /employee_groups

Imports selected staged OIDC groups from their OIDC provider.

Optional parameters:

  • import_all_from: Pass the id of the staged OIDC group import session to import all staged OIDC groups from that session.
  • staged_oidc_group_ids: A list IDs of the staged OIDC groups to import.

Note: exactly one of import_all_from and staged_oidc_group_ids should be included with the request.

Example requests:

curl -X POST "https://landscape.canonical.com/api/v2/employee_groups" -H "Authorization: Bearer $JWT" -d '{"staged_oidc_group_ids": [1, 2, 3]}'

curl -X POST "https://landscape.canonical.com/api/v2/employee_groups" -H "Authorization: Bearer $JWT" -d '{"import_all": 7}'

Example response:

{
    "count": 1000
    "results": [
        1,
        2,
        3,
        ...
    ]
}

POST /oidc/groups/import_session

Creates a new OIDC group import session. The groups will be staged in a background task.

Required parameters:

  • issuer_id: The id of the issuer.

Example request:

curl -X POST "https://landscape.canonical.com/api/v2/oidc/groups/import_session" -H "Authorization: Bearer $JWT" -d '{"issuer_id": 123}'

Example output:

{
   "id": 1,
   "account_id": 312,
   "status": "IN_PROGRESS",
   "issuer_id": 123,
   "synced_at": "2024-02-07T17:30:16Z"
}

GET /oidc/groups/import_session/<id>

Gets information about an OIDC group import session. Used as a polling endpoint while the group import completes.

Path parameters:

  • id: ID of the OIDC groups import session.

Example request:

curl -X GET "https://landscape.canonical.com/api/v2/oidc/groups/import_session/1" -H "Authorization: Bearer $JWT"

Example output:

{
   "id": 1,
   "account_id": 312,
   "status": "IN_PROGRESS",
   "issuer_id": 123,
   "synced_at": "2024-02-07T17:30:16Z"
}

GET /oidc/groups/staged

Lists all staged OIDC groups.

Required query parameters:

  • import_session_id: The ID of the OIDC group import session.

Optional query parameters:

  • include_imported: Whether or not to include OIDC groups that have already been imported. Defaults to false.

Example request:

curl -X GET "https://landscape.canonical.com/api/v2/oidc/groups/staged" -H "Authorization: Bearer $JWT"

Example output:

{
   "count": 500,
   "results": [
       {
           "id": 1,
           "account_id": 312,
           "issuer_id": 123,
           "group_id": "1239fzxv39fvzcz3fcwp",
           "name": "Marketing",
           "import_session_id": 3
       },
       {
           "id": 2,
           "account_id": 312,
           "issuer_id": 123,
           "group_id": "ij9v3490vjxczl209jxc",
           "name": "Engineering",
           "import_session_id": 3
       },
       ...
   ]
}
Previous Reference Next Activities

This page was last modified 9 minutes ago. Help improve this document in the forum.