From 589849882803bd506f1bb9218b520dfc6bc62de8 Mon Sep 17 00:00:00 2001 From: Thodoris Greasidis Date: Tue, 8 Oct 2024 22:27:39 +0300 Subject: [PATCH 01/13] API/overview: Replace the my_application resource with an application.is_directly_accessible_by__user filter Change-type: major --- config/dictionaries/resource.json | 2 +- pages/reference/api/overview.md | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/config/dictionaries/resource.json b/config/dictionaries/resource.json index c35ab8873..aa265a9c6 100644 --- a/config/dictionaries/resource.json +++ b/config/dictionaries/resource.json @@ -45,7 +45,7 @@ "description": "", "method": "GET", "endpoint": "/v6/application", - "filters": "?\\$filter=is_directly_accessible_by__user/any(dau:1%20eq%201)" + "filters": "?\\$filter=is_directly_accessible_by__user/any(dau:true)" }, { "id": "app-by-id", diff --git a/pages/reference/api/overview.md b/pages/reference/api/overview.md index 8c6e451f4..e163a4e14 100644 --- a/pages/reference/api/overview.md +++ b/pages/reference/api/overview.md @@ -37,14 +37,6 @@ curl -X GET "{{ $links.apiBase }}/v6/application" \ -H "Authorization: Bearer " ``` -If you want to limit this to only return fleets related to the authenticated user, use the `my_application` resource. For example: - -```shell -curl -X GET "{{ $links.apiBase }}/v6/my_application" \ --H "Content-Type: application/json" \ --H "Authorization: Bearer " -``` - Depending on the number of fleets you have access to, this could return much more information than you need. There are two query methods that could help you with this: `$select` and `$filter`. `$select` specifies which fields to return for each resource. By default, every field comes back as part of the response, but most use cases require only one or two of these pieces of information. @@ -111,6 +103,14 @@ curl -X GET \ -H "Authorization: Bearer " ``` +If you want to extend this to return all fleets that are related with the authenticated user across all organizations that it is a member of, you can then use a `$filter` on the `is_directly_accessible_by__user` property. For example: + +```shell +curl -X GET "{{ $links.apiBase }}/v6/application?\$filter=is_directly_accessible_by__user/any(dau:true)" \ +-H "Content-Type: application/json" \ +-H "Authorization: Bearer " +``` + A final tip for constructing API calls: for some of the fields in the API response, a link to another resource is provided rather than the complete information about that resource. For example, if you make a call requesting information about a specific device, the `belongs_to__application` field will return a link to an application, but not all the information about that application. To get all the fields for the application resource, you can use the `$expand` method: From 4a5503eef743078b72d48466a84635e07084f490 Mon Sep 17 00:00:00 2001 From: Thodoris Greasidis Date: Tue, 8 Oct 2024 20:09:14 +0300 Subject: [PATCH 02/13] API/resources: Drop the device.logs_channel property since it's not part of the v7 model Change-type: major --- config/dictionaries/resource.json | 1 - 1 file changed, 1 deletion(-) diff --git a/config/dictionaries/resource.json b/config/dictionaries/resource.json index aa265a9c6..cddc5ed53 100644 --- a/config/dictionaries/resource.json +++ b/config/dictionaries/resource.json @@ -316,7 +316,6 @@ "location", "custom_longitude", "custom_latitude", - "logs_channel", "is_locked_until__date", "is_accessible_by_support_until__date", "created_at", From bc346e134efa604b9c0582c5640b8d83e4de93de Mon Sep 17 00:00:00 2001 From: Thodoris Greasidis Date: Tue, 8 Oct 2024 20:10:12 +0300 Subject: [PATCH 03/13] API/resources: Drop the device.is_managed_by__device property since it's not part of the v7 model Change-type: major --- config/dictionaries/resource.json | 1 - 1 file changed, 1 deletion(-) diff --git a/config/dictionaries/resource.json b/config/dictionaries/resource.json index cddc5ed53..9cc6c6d44 100644 --- a/config/dictionaries/resource.json +++ b/config/dictionaries/resource.json @@ -284,7 +284,6 @@ "id", "belongs_to__application", "belongs_to__user", - "is_managed_by__device", "actor", "should_be_running__release", "device_name", From 251a0fee7cc8fb87600e5c596f12c03673207c7a Mon Sep 17 00:00:00 2001 From: Thodoris Greasidis Date: Tue, 8 Oct 2024 20:10:54 +0300 Subject: [PATCH 04/13] API/resources: Drop the application.depends_on__application property since it's not part of the v7 model Change-type: major --- config/dictionaries/resource.json | 1 - 1 file changed, 1 deletion(-) diff --git a/config/dictionaries/resource.json b/config/dictionaries/resource.json index 9cc6c6d44..5edc15897 100644 --- a/config/dictionaries/resource.json +++ b/config/dictionaries/resource.json @@ -6,7 +6,6 @@ "id", "uuid", "organization", - "depends_on__application", "actor", "app_name", "slug", From 538b6a848c9bd99eceb7aa99999e2e2aee1ec162 Mon Sep 17 00:00:00 2001 From: Thodoris Greasidis Date: Tue, 8 Oct 2024 20:16:03 +0300 Subject: [PATCH 05/13] API/resources: Change the application POST to use the is_for__device_type property Change-type: major --- config/dictionaries/resource.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config/dictionaries/resource.json b/config/dictionaries/resource.json index 5edc15897..dab6034f9 100644 --- a/config/dictionaries/resource.json +++ b/config/dictionaries/resource.json @@ -93,7 +93,7 @@ "method": "POST", "endpoint": "/v6/application", "filters": "", - "data": "{\n \"app_name\": \"\",\n \"device_type\": \"\"\n}" + "data": "{\n \"app_name\": \"\",\n \"is_for__device_type\": \n}" }, { "id": "delete-app", From 2f1c15055b2547102e444d76016ddcc57bd1b498 Mon Sep 17 00:00:00 2001 From: Thodoris Greasidis Date: Tue, 8 Oct 2024 21:10:18 +0300 Subject: [PATCH 06/13] API/resources: Add the organization field in the body of the application POST example since its mandatory in v7 Change-type: major --- config/dictionaries/resource.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/config/dictionaries/resource.json b/config/dictionaries/resource.json index dab6034f9..bcafda4e6 100644 --- a/config/dictionaries/resource.json +++ b/config/dictionaries/resource.json @@ -89,11 +89,11 @@ { "id": "create-app", "summary": "Create fleet", - "description": "", + "description": "To retrieve the numeric ORGANIZATION_ID & DEVICE_TYPE_ID, check the respective documentation page for the organization & device type resources.", "method": "POST", "endpoint": "/v6/application", "filters": "", - "data": "{\n \"app_name\": \"\",\n \"is_for__device_type\": \n}" + "data": "{\n \"app_name\": \"\",\n \"organization\": ,\n \"is_for__device_type\": \n}" }, { "id": "delete-app", From 1dcc17ece034d16c9601f8eea06ccfeaf5f4cdf2 Mon Sep 17 00:00:00 2001 From: Thodoris Greasidis Date: Tue, 8 Oct 2024 21:18:13 +0300 Subject: [PATCH 07/13] API/resources: Add an example for the device.is_running__release property Change-type: minor --- config/dictionaries/resource.json | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/config/dictionaries/resource.json b/config/dictionaries/resource.json index bcafda4e6..355bf5119 100644 --- a/config/dictionaries/resource.json +++ b/config/dictionaries/resource.json @@ -370,10 +370,18 @@ "endpoint": "/v6/device()", "filters": "?\\$select=overall_status" }, + { + "id": "get-current-release", + "summary": "Get the release currently running on a device", + "method": "GET", + "endpoint": "/v6/device()", + "filters": "?\\$select=is_running__release", + "data": "" + }, { "id": "get-target-release", - "summary": "Get the release device is pinned to", - "description": "Note: should_be_running__release will be unset or null if the device isn't pinned to any release. For an unpinned device, the device.is_running__release field may be used to obtain the device's current state.", + "summary": "Get the release a device is pinned to", + "description": "Note: should_be_running__release will be null/not set if the device isn't pinned to any release, in which case the device will be tracking the release of the application it belongs to.", "method": "GET", "endpoint": "/v6/device()", "filters": "?\\$select=should_be_running__release", From bfaf4b6f8d8de9e7363664ae22b93d2e30c5059f Mon Sep 17 00:00:00 2001 From: Thodoris Greasidis Date: Tue, 8 Oct 2024 21:20:00 +0300 Subject: [PATCH 08/13] API/resources: Replace the device.should_be_running__release property with the v7 device.is_pinned_on__release Change-type: major --- config/dictionaries/resource.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/config/dictionaries/resource.json b/config/dictionaries/resource.json index 355bf5119..cf1febf39 100644 --- a/config/dictionaries/resource.json +++ b/config/dictionaries/resource.json @@ -284,7 +284,7 @@ "belongs_to__application", "belongs_to__user", "actor", - "should_be_running__release", + "is_pinned_on__release", "device_name", "is_of__device_type", "uuid", @@ -381,10 +381,10 @@ { "id": "get-target-release", "summary": "Get the release a device is pinned to", - "description": "Note: should_be_running__release will be null/not set if the device isn't pinned to any release, in which case the device will be tracking the release of the application it belongs to.", + "description": "Note: is_pinned_on__release will be null/not set if the device isn't pinned to any release, in which case the device will be tracking the release of the application it belongs to.", "method": "GET", "endpoint": "/v6/device()", - "filters": "?\\$select=should_be_running__release", + "filters": "?\\$select=is_pinned_on__release", "data": "" }, { @@ -394,7 +394,7 @@ "method": "PATCH", "endpoint": "/v6/device()", "filters": "", - "data": "{\n \"should_be_running__release\": \"\"\n}" + "data": "{\n \"is_pinned_on__release\": \n}" }, { "id": "set-device-to-release-by-uuid", @@ -403,7 +403,7 @@ "method": "PATCH", "endpoint": "/v6/device(uuid='')", "filters": "", - "data": "{\n \"should_be_running__release\": \"\"\n}" + "data": "{\n \"is_pinned_on__release\": \n}" }, { "id": "update-device-supervisor-by-uuid", From fef6500141d93f453ba85f19a14e58d89579b827 Mon Sep 17 00:00:00 2001 From: Thodoris Greasidis Date: Fri, 18 Oct 2024 19:55:17 +0300 Subject: [PATCH 09/13] API/resources: Drop the supervisor_release resource Change-type: major --- config/dictionaries/resource.json | 36 ------------------------------- 1 file changed, 36 deletions(-) diff --git a/config/dictionaries/resource.json b/config/dictionaries/resource.json index cf1febf39..37c4fc192 100644 --- a/config/dictionaries/resource.json +++ b/config/dictionaries/resource.json @@ -1145,42 +1145,6 @@ } ] }, - { - "id": "supervisor_release", - "name": "Supervisor release", - "fields": [ - "id", - "supervisor_version", - "is_for__device_type", - "image_name" - ], - "examples": [ - { - "id": "get-supervisor-releases", - "summary": "Get all supervisor releases for a device type by device type ID", - "description": "", - "method": "GET", - "endpoint": "/v6/supervisor_release", - "filters": "?\\$filter=is_for__device_type%20eq%20''" - }, - { - "id": "get-supervisor-releases-by-device-type-slug", - "summary": "Get all supervisor releases for a device type by device type slug", - "description": "", - "method": "GET", - "endpoint": "/v6/supervisor_release", - "filters": "?\\$filter=is_for__device_type/any(dt:dt/slug%20eq%20%27%27)" - }, - { - "id": "get-supervisor-release-by-device-type-slug-and-version", - "summary": "Get a specific supervisor release version for a device type", - "description": "", - "method": "GET", - "endpoint": "/v6/supervisor_release", - "filters": "?\\$filter=(is_for__device_type/any(dt:dt/slug%20eq%20%27%27))%20and%20(supervisor_version%20eq%20%27v%27)" - } - ] - }, { "id": "user", "name": "User", From 574d4200b12f9fcc77be33d976670fd9e7d0a8e4 Mon Sep 17 00:00:00 2001 From: Thodoris Greasidis Date: Fri, 18 Oct 2024 19:59:18 +0300 Subject: [PATCH 10/13] API/resources: Add examples for fetching the supervisor releases Change-type: minor --- config/dictionaries/resource.json | 34 +++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/config/dictionaries/resource.json b/config/dictionaries/resource.json index 37c4fc192..796c1c28d 100644 --- a/config/dictionaries/resource.json +++ b/config/dictionaries/resource.json @@ -1011,6 +1011,40 @@ } ] }, + { + "id": "supervisor_release", + "name": "List Supervisor releases", + "fields": [ + "id", + "raw_version" + ], + "examples": [ + { + "id": "get-supervisor-releases-by-cpu-architecture-slug", + "summary": "Get all supervisor releases for a specific cpu architecture by slug (eg amd64/rpi/armv7hf/aarch64)", + "description": "To request a list of the supported supervisor releases for a particular cpu architecture, the `CPU_ARCHITECTURE_SLUG` parameter is required. Even though this query only selects the `id` and `raw_version` fields, you can additionally specify any of the fields found in the release resource. The Authorization header is optional.", + "method": "GET", + "endpoint": "/v6/release", + "filters": "?\\$select=id,raw_version&\\$filter=(status%20eq%20%27success%27)%20and%20(is_final%20eq%20true)%20and%20(is_invalidated%20eq%20false)%20and%20(semver_major%20gt%200)%20and%20(belongs_to__application/any(a:(startswith(a/slug,%27balena_os%2F%27)%20and%20endswith(a/slug,%27-supervisor%27))%20and%20((a/is_public%20eq%20true)%20and%20(a/is_host%20eq%20false)%20and%20(a/is_for__device_type/any(dt:dt/is_of__cpu_architecture/any(c:c/slug%20eq%20%27%27))))))&\\$orderby=semver_major%20desc,semver_minor%20desc,semver_patch%20desc,revision%20desc" + }, + { + "id": "get-supervisor-releases-by-cpu-architecture-id", + "summary": "Get all supervisor releases for a specific cpu architecture by ID", + "description": "", + "method": "GET", + "endpoint": "/v6/release", + "filters": "?\\$select=id,raw_version&\\$filter=(status%20eq%20%27success%27)%20and%20(is_final%20eq%20true)%20and%20(is_invalidated%20eq%20false)%20and%20(semver_major%20gt%200)%20and%20(belongs_to__application/any(a:(startswith(a/slug,%27balena_os%2F%27)%20and%20endswith(a/slug,%27-supervisor%27))%20and%20((a/is_public%20eq%20true)%20and%20(a/is_host%20eq%20false)%20and%20(a/is_for__device_type/any(dt:dt/is_of__cpu_architecture%20eq%20)))))&\\$orderby=semver_major%20desc,semver_minor%20desc,semver_patch%20desc,revision%20desc" + }, + { + "id": "get-supervisor-releases-by-cpu-architecture-slug-and-version", + "summary": "Get a specific supervisor release version for a specific cpu architecture", + "description": "", + "method": "GET", + "endpoint": "/v6/release", + "filters": "?\\$select=id,raw_version&\\$filter=(status%20eq%20%27success%27)%20and%20(is_final%20eq%20true)%20and%20(is_invalidated%20eq%20false)%20and%20(semver_major%20gt%200)%20and%20(belongs_to__application/any(a:(startswith(a/slug,%27balena_os%2F%27)%20and%20endswith(a/slug,%27-supervisor%27))%20and%20((a/is_public%20eq%20true)%20and%20(a/is_host%20eq%20false)%20and%20(a/is_for__device_type/any(dt:dt/is_of__cpu_architecture/any(c:c/slug%20eq%20%27%27))))))%20and%20(raw_version%20eq%20%27%27)&\\$orderby=semver_major%20desc,semver_minor%20desc,semver_patch%20desc,revision%20desc" + } + ] + }, { "id": "balenaos_versions", "name": "List balenaOS versions", From 7460dc8306ebcf113c6d1d84788baf5ca0b32145 Mon Sep 17 00:00:00 2001 From: Thodoris Greasidis Date: Tue, 8 Oct 2024 21:03:44 +0300 Subject: [PATCH 11/13] API/resources: Replace the device.should_be_managed_by__supervisor_release property with the v7 device.should_be_managed_by__release Chaneg-type: major --- config/dictionaries/resource.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/config/dictionaries/resource.json b/config/dictionaries/resource.json index 796c1c28d..ce94655d8 100644 --- a/config/dictionaries/resource.json +++ b/config/dictionaries/resource.json @@ -303,7 +303,7 @@ "os_version", "os_variant", "supervisor_version", - "should_be_managed_by__supervisor_release", + "should_be_managed_by__release", "is_managed_by__service_instance", "provisioning_progress", "provisioning_state", @@ -412,7 +412,7 @@ "method": "PATCH", "endpoint": "/v6/device(uuid='')", "filters": "", - "data": "{\n \"should_be_managed_by__supervisor_release\": \"\"\n}" + "data": "{\n \"should_be_managed_by__release\": \n}" }, { "id": "rename-device", From ef8e3a418112edb219e45a809646a61610e7ce31 Mon Sep 17 00:00:00 2001 From: Thodoris Greasidis Date: Fri, 18 Oct 2024 20:14:50 +0300 Subject: [PATCH 12/13] API/resources: Change the balenaOS versions title to balenaOS releases Change-type: patch --- config/dictionaries/resource.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config/dictionaries/resource.json b/config/dictionaries/resource.json index ce94655d8..f8e45931a 100644 --- a/config/dictionaries/resource.json +++ b/config/dictionaries/resource.json @@ -1047,7 +1047,7 @@ }, { "id": "balenaos_versions", - "name": "List balenaOS versions", + "name": "List balenaOS releases", "fields": [], "examples": [ { From f57f65b394f30fae3b449a373e4e05f9d2d969de Mon Sep 17 00:00:00 2001 From: Thodoris Greasidis Date: Fri, 18 Oct 2024 20:17:46 +0300 Subject: [PATCH 13/13] API/resources: Change the requests to use the v7 endpoint Change-type: major --- config/dictionaries/resource.json | 212 +++++++++++++++--------------- 1 file changed, 106 insertions(+), 106 deletions(-) diff --git a/config/dictionaries/resource.json b/config/dictionaries/resource.json index f8e45931a..cfb839a08 100644 --- a/config/dictionaries/resource.json +++ b/config/dictionaries/resource.json @@ -27,7 +27,7 @@ "summary": "Get all fleets of an organization by its HANDLE", "description": "", "method": "GET", - "endpoint": "/v6/application", + "endpoint": "/v7/application", "filters": "?\\$filter=organization/any(o:o/handle%20eq%20%27%27)" }, { @@ -35,7 +35,7 @@ "summary": "Get all fleets", "description": "Note: This will also include all public fleets of the platform. In most cases retrieving the fleets by their organization will be preferable.", "method": "GET", - "endpoint": "/v6/application", + "endpoint": "/v7/application", "filters": "" }, { @@ -43,7 +43,7 @@ "summary": "Get all fleets associated with authenticated user", "description": "", "method": "GET", - "endpoint": "/v6/application", + "endpoint": "/v7/application", "filters": "?\\$filter=is_directly_accessible_by__user/any(dau:true)" }, { @@ -51,7 +51,7 @@ "summary": "Get fleet by ID", "description": "", "method": "GET", - "endpoint": "/v6/application()", + "endpoint": "/v7/application()", "filters": "" }, { @@ -59,7 +59,7 @@ "summary": "Get fleet by SLUG", "description": "", "method": "GET", - "endpoint": "/v6/application(slug='')", + "endpoint": "/v7/application(slug='')", "filters": "" }, { @@ -67,7 +67,7 @@ "summary": "Get fleet by name", "description": "", "method": "GET", - "endpoint": "/v6/application", + "endpoint": "/v7/application", "filters": "?\\$filter=app_name%20eq%20''" }, { @@ -75,7 +75,7 @@ "summary": "Get fleet by id along with its devices", "description": "", "method": "GET", - "endpoint": "/v6/application()", + "endpoint": "/v7/application()", "filters": "?\\$expand=owns__device" }, { @@ -83,7 +83,7 @@ "summary": "Filter public fleets from result", "description": "", "method": "GET", - "endpoint": "/v6/application", + "endpoint": "/v7/application", "filters": "?\\$filter=is_public%20eq%20false" }, { @@ -91,7 +91,7 @@ "summary": "Create fleet", "description": "To retrieve the numeric ORGANIZATION_ID & DEVICE_TYPE_ID, check the respective documentation page for the organization & device type resources.", "method": "POST", - "endpoint": "/v6/application", + "endpoint": "/v7/application", "filters": "", "data": "{\n \"app_name\": \"\",\n \"organization\": ,\n \"is_for__device_type\": \n}" }, @@ -100,7 +100,7 @@ "summary": "Delete fleet", "description": "", "method": "DELETE", - "endpoint": "/v6/application()", + "endpoint": "/v7/application()", "filters": "" }, { @@ -108,7 +108,7 @@ "summary": "Pin entire fleet to a specific release by ID", "description": "", "method": "PATCH", - "endpoint": "/v6/application()", + "endpoint": "/v7/application()", "filters": "", "data": "{\n \"should_be_running__release\": \"\"\n \"should_track_latest_release\": false\n}" }, @@ -117,7 +117,7 @@ "summary": "Pin entire fleet to a specific release by SLUG", "description": "", "method": "PATCH", - "endpoint": "/v6/application(slug='')", + "endpoint": "/v7/application(slug='')", "filters": "", "data": "{\n \"should_be_running__release\": \"\"\n \"should_track_latest_release\": false\n}" }, @@ -126,7 +126,7 @@ "summary": "Disable automatic update tracking for a fleet", "description": "", "method": "PATCH", - "endpoint": "/v6/application()", + "endpoint": "/v7/application()", "filters": "", "data": "{\n \"should_track_latest_release\": \"false\"\n}" }, @@ -135,7 +135,7 @@ "summary": "Enable automatic update tracking for a fleet", "description": "", "method": "PATCH", - "endpoint": "/v6/application()", + "endpoint": "/v7/application()", "filters": "", "data": "{\n \"should_track_latest_release\": \"true\"\n}" } @@ -154,7 +154,7 @@ "summary": "Get all fleet membership roles", "description": "", "method": "GET", - "endpoint": "/v6/application_membership_role", + "endpoint": "/v7/application_membership_role", "filters": "" } ] @@ -174,7 +174,7 @@ "summary": "Get all tags by fleet name", "description": "", "method": "GET", - "endpoint": "/v6/application_tag", + "endpoint": "/v7/application_tag", "filters": "?\\$filter=application/app_name%20eq%20''" }, { @@ -182,7 +182,7 @@ "summary": "Create a new fleet tag", "description": "", "method": "POST", - "endpoint": "/v6/application_tag", + "endpoint": "/v7/application_tag", "filters": "", "data": "{\n \"application\": \"\",\n \"tag_key\": \"\",\n \"value\": \"\"\n}" }, @@ -191,7 +191,7 @@ "summary": "Update a fleet tag", "description": "", "method": "PATCH", - "endpoint": "/v6/application_tag/()", + "endpoint": "/v7/application_tag/()", "filters": "", "data": "{\n \"value\": \"\"\n}" }, @@ -200,7 +200,7 @@ "summary": "Delete a fleet tag", "description": "", "method": "DELETE", - "endpoint": "/v6/application_tag/()", + "endpoint": "/v7/application_tag/()", "filters": "" } ] @@ -221,7 +221,7 @@ "summary": "Get all API keys", "description": "", "method": "GET", - "endpoint": "/v6/api_key", + "endpoint": "/v7/api_key", "filters": "" }, { @@ -229,7 +229,7 @@ "summary": "Get all API keys of a device by UUID", "description": "", "method": "GET", - "endpoint": "/v6/api_key", + "endpoint": "/v7/api_key", "filters": "?\\$filter=is_of__actor/any(a:a/is_of__device/any(d:d/uuid%20eq%20''))" }, { @@ -237,7 +237,7 @@ "summary": "Get all API keys of an application by slug", "description": "", "method": "GET", - "endpoint": "/v6/api_key", + "endpoint": "/v7/api_key", "filters": "?\\$filter=is_of__actor/any(a:a/is_of__application/any(ioa:ioa/slug%20eq%20''))" }, { @@ -245,7 +245,7 @@ "summary": "Get all user API keys for the authenticated user", "description": "", "method": "GET", - "endpoint": "/v6/api_key", + "endpoint": "/v7/api_key", "filters": "?\\$filter=is_of__actor/any(a:a/is_of__user%20eq%20))" }, { @@ -253,7 +253,7 @@ "summary": "Update the expiry date for an API Key", "description": "Note: Select a date in the past to expire an API Key immediately.", "method": "PATCH", - "endpoint": "/v6/api_key()", + "endpoint": "/v7/api_key()", "filters": "", "data": "{\n \"expiry_date\": \"\"\n}" }, @@ -261,7 +261,7 @@ "id": "clear-api-key-expiry-date", "summary": "Clear the expiry date of an API Key", "method": "PATCH", - "endpoint": "/v6/api_key()", + "endpoint": "/v7/api_key()", "filters": "", "data": "{\n \"expiry_date\": null\n}" }, @@ -335,7 +335,7 @@ "summary": "Get all devices", "description": "", "method": "GET", - "endpoint": "/v6/device", + "endpoint": "/v7/device", "filters": "" }, { @@ -343,7 +343,7 @@ "summary": "Get all devices by fleet", "description": "", "method": "GET", - "endpoint": "/v6/device", + "endpoint": "/v7/device", "filters": "?\\$filter=belongs_to__application%20eq%20''" }, { @@ -351,7 +351,7 @@ "summary": "Get device by ID", "description": "", "method": "GET", - "endpoint": "/v6/device()", + "endpoint": "/v7/device()", "filters": "" }, { @@ -359,7 +359,7 @@ "summary": "Get device by UUID", "description": "", "method": "GET", - "endpoint": "/v6/device(uuid='')", + "endpoint": "/v7/device(uuid='')", "filters": "" }, { @@ -367,14 +367,14 @@ "summary": "Get the device overall_status field", "description": "The overall_status field is returned only when explicitly requested with $select.", "method": "GET", - "endpoint": "/v6/device()", + "endpoint": "/v7/device()", "filters": "?\\$select=overall_status" }, { "id": "get-current-release", "summary": "Get the release currently running on a device", "method": "GET", - "endpoint": "/v6/device()", + "endpoint": "/v7/device()", "filters": "?\\$select=is_running__release", "data": "" }, @@ -383,7 +383,7 @@ "summary": "Get the release a device is pinned to", "description": "Note: is_pinned_on__release will be null/not set if the device isn't pinned to any release, in which case the device will be tracking the release of the application it belongs to.", "method": "GET", - "endpoint": "/v6/device()", + "endpoint": "/v7/device()", "filters": "?\\$select=is_pinned_on__release", "data": "" }, @@ -392,7 +392,7 @@ "summary": "Pin device to a specific release by ID", "description": "", "method": "PATCH", - "endpoint": "/v6/device()", + "endpoint": "/v7/device()", "filters": "", "data": "{\n \"is_pinned_on__release\": \n}" }, @@ -401,7 +401,7 @@ "summary": "Pin device to a specific release by UUID", "description": "", "method": "PATCH", - "endpoint": "/v6/device(uuid='')", + "endpoint": "/v7/device(uuid='')", "filters": "", "data": "{\n \"is_pinned_on__release\": \n}" }, @@ -410,7 +410,7 @@ "summary": "Mark a device to be updated to a specific supervisor release", "description": "To request a list of available supervisor versions, check the respective documentation page for the supervisor release resource.", "method": "PATCH", - "endpoint": "/v6/device(uuid='')", + "endpoint": "/v7/device(uuid='')", "filters": "", "data": "{\n \"should_be_managed_by__release\": \n}" }, @@ -419,7 +419,7 @@ "summary": "Rename device", "description": "", "method": "PATCH", - "endpoint": "/v6/device()", + "endpoint": "/v7/device()", "filters": "", "data": "{\n \"device_name\": \"\"\n}" }, @@ -428,7 +428,7 @@ "summary": "Delete device", "description": "", "method": "DELETE", - "endpoint": "/v6/device()", + "endpoint": "/v7/device()", "filters": "" }, { @@ -436,7 +436,7 @@ "summary": "Add note to a device", "description": "", "method": "PATCH", - "endpoint": "/v6/device()", + "endpoint": "/v7/device()", "filters": "", "data": "{\n \"note\": \"\"\n}" }, @@ -445,7 +445,7 @@ "summary": "Move device to another fleet", "description": "", "method": "PATCH", - "endpoint": "/v6/device()", + "endpoint": "/v7/device()", "filters": "", "data": "{\n \"belongs_to__application\": \"\"\n}" }, @@ -454,7 +454,7 @@ "summary": "Deactivate an offline device (CHARGEABLE)", "description": "", "method": "PATCH", - "endpoint": "/v6/device()", + "endpoint": "/v7/device()", "filters": "", "data": "{\n \"is_active\": false\n}" } @@ -477,7 +477,7 @@ "summary": "Get a device type by its ID", "description": "When querying a private device type it's necessary to include your bearer token. For public device types the auth header is optional.", "method": "GET", - "endpoint": "/v6/device_type()", + "endpoint": "/v7/device_type()", "filters": "" }, { @@ -485,7 +485,7 @@ "summary": "Get a device type by its SLUG", "description": "When querying a private device type it's necessary to include your bearer token. For public device types the auth header is optional.", "method": "GET", - "endpoint": "/v6/device_type(slug='')", + "endpoint": "/v7/device_type(slug='')", "filters": "" }, { @@ -493,7 +493,7 @@ "summary": "Get a device type by its NAME", "description": "When querying a private device type it's necessary to include your bearer token. For public device types the auth header is optional.", "method": "GET", - "endpoint": "/v6/device_type", + "endpoint": "/v7/device_type", "filters": "?\\$filter=name%20eq%20''" }, { @@ -501,7 +501,7 @@ "summary": "Get all supported device types", "description": "When querying a private device type it's necessary to include your bearer token. For public device types the auth header is optional.", "method": "GET", - "endpoint": "/v6/device_type", + "endpoint": "/v7/device_type", "filters": "?\\$filter=is_default_for__application/any(idfa:(idfa/is_host%20eq%20true)%20and%20(idfa/is_archived%20eq%20false)%20and%20(idfa/owns__release/any(r:(r/status%20eq%20'success')%20and%20(r/is_final%20eq%20true)%20and%20(r/is_invalidated%20eq%20false))))&\\$orderby=name%20asc" } ] @@ -521,7 +521,7 @@ "summary": "Get all device config variables for a device", "description": "", "method": "GET", - "endpoint": "/v6/device_config_variable", + "endpoint": "/v7/device_config_variable", "filters": "?\\$filter=device%20eq%20" }, { @@ -529,7 +529,7 @@ "summary": "Create a device config variable", "description": "", "method": "POST", - "endpoint": "/v6/device_config_variable", + "endpoint": "/v7/device_config_variable", "filters": "", "data": "{\n \"device\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n}" }, @@ -538,7 +538,7 @@ "summary": "Update a device config variable", "description": "", "method": "PATCH", - "endpoint": "/v6/device_config_variable()", + "endpoint": "/v7/device_config_variable()", "filters": "", "data": "{\n \"value\": \"\"\n}" }, @@ -547,7 +547,7 @@ "summary": "Remove a device config variable", "description": "", "method": "DELETE", - "endpoint": "/v6/device_config_variable()", + "endpoint": "/v7/device_config_variable()", "filters": "" } ] @@ -568,7 +568,7 @@ "summary": "Get all device environment variables for a device by UUID", "description": "", "method": "GET", - "endpoint": "/v6/device_environment_variable", + "endpoint": "/v7/device_environment_variable", "filters": "?\\$filter=device/any(d:d/uuid%20eq%20'')" }, { @@ -576,7 +576,7 @@ "summary": "Get all device environment variables for a device by ID", "description": "", "method": "GET", - "endpoint": "/v6/device_environment_variable", + "endpoint": "/v7/device_environment_variable", "filters": "?\\$filter=device%20eq%20" }, { @@ -584,7 +584,7 @@ "summary": "Create a device environment variable", "description": "", "method": "POST", - "endpoint": "/v6/device_environment_variable", + "endpoint": "/v7/device_environment_variable", "filters": "", "data": "{\n \"device\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n}" }, @@ -593,7 +593,7 @@ "summary": "Update a device environment variable", "description": "", "method": "PATCH", - "endpoint": "/v6/device_environment_variable()", + "endpoint": "/v7/device_environment_variable()", "filters": "", "data": "{\n \"value\": \"\"\n}" }, @@ -602,7 +602,7 @@ "summary": "Remove a device environment variable", "description": "", "method": "DELETE", - "endpoint": "/v6/device_environment_variable()", + "endpoint": "/v7/device_environment_variable()", "filters": "" } ] @@ -623,7 +623,7 @@ "summary": "Get all service variables for a device by UUID", "description": "", "method": "GET", - "endpoint": "/v6/device_service_environment_variable", + "endpoint": "/v7/device_service_environment_variable", "filters": "?\\$filter=service_install/any(si:si/device/any(d:d/uuid%20eq%20''))" }, { @@ -631,7 +631,7 @@ "summary": "Get all service variables for a device by UUID, including the service name", "description": "", "method": "GET", - "endpoint": "/v6/device_service_environment_variable", + "endpoint": "/v7/device_service_environment_variable", "filters": "?\\$filter=service_install/any(si:si/device/any(d:d/uuid%20eq%20''))&\\$expand=service_install(\\$expand=installs__service(\\$select=id,service_name))" }, { @@ -639,7 +639,7 @@ "summary": "Get all service variables for a device by ID", "description": "", "method": "GET", - "endpoint": "/v6/device_service_environment_variable", + "endpoint": "/v7/device_service_environment_variable", "filters": "?\\$filter=service_install/device%20eq%20" }, { @@ -647,7 +647,7 @@ "summary": "Create a device service variable", "description": "", "method": "POST", - "endpoint": "/v6/device_service_environment_variable", + "endpoint": "/v7/device_service_environment_variable", "filters": "", "data": "{\n \"service_install\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n}" }, @@ -656,7 +656,7 @@ "summary": "Update a device service variable", "description": "", "method": "PATCH", - "endpoint": "/v6/device_service_environment_variable()", + "endpoint": "/v7/device_service_environment_variable()", "filters": "", "data": "{\n \"value\": \"\"\n}" }, @@ -665,7 +665,7 @@ "summary": "Remove a device service variable", "description": "", "method": "DELETE", - "endpoint": "/v6/device_service_environment_variable()", + "endpoint": "/v7/device_service_environment_variable()", "filters": "" } ] @@ -685,7 +685,7 @@ "summary": "Get all tags by device UUID", "description": "", "method": "GET", - "endpoint": "/v6/device_tag", + "endpoint": "/v7/device_tag", "filters": "?\\$filter=device/uuid%20eq%20''" }, { @@ -693,7 +693,7 @@ "summary": "Create a new device tag", "description": "", "method": "POST", - "endpoint": "/v6/device_tag", + "endpoint": "/v7/device_tag", "filters": "", "data": "{\n \"device\": \"\",\n \"tag_key\": \"\",\n \"value\": \"\"\n}" }, @@ -702,7 +702,7 @@ "summary": "Update a device tag", "description": "", "method": "PATCH", - "endpoint": "/v6/device_tag(device=,tag_key='')", + "endpoint": "/v7/device_tag(device=,tag_key='')", "filters": "", "data": "{\n \"value\": \"\"\n}" }, @@ -711,7 +711,7 @@ "summary": "Delete a device tag given its database ID", "description": "", "method": "DELETE", - "endpoint": "/v6/device_tag()", + "endpoint": "/v7/device_tag()", "filters": "" } ] @@ -731,7 +731,7 @@ "summary": "Get all fleet config variables for a fleet", "description": "", "method": "GET", - "endpoint": "/v6/application_config_variable", + "endpoint": "/v7/application_config_variable", "filters": "?\\$filter=application%20eq%20" }, { @@ -739,7 +739,7 @@ "summary": "Create a fleet config variable", "description": "", "method": "POST", - "endpoint": "/v6/application_config_variable", + "endpoint": "/v7/application_config_variable", "filters": "", "data": "{\n \"application\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n}" }, @@ -748,7 +748,7 @@ "summary": "Update a fleet environment variable", "description": "", "method": "PATCH", - "endpoint": "/v6/application_config_variable()", + "endpoint": "/v7/application_config_variable()", "filters": "", "data": "{\n \"value\": \"\"\n}" }, @@ -757,7 +757,7 @@ "summary": "Remove a fleet config variable", "description": "", "method": "DELETE", - "endpoint": "/v6/application_config_variable()", + "endpoint": "/v7/application_config_variable()", "filters": "" } ] @@ -778,7 +778,7 @@ "summary": "Get all fleet environment variables for a fleet", "description": "", "method": "GET", - "endpoint": "/v6/application_environment_variable", + "endpoint": "/v7/application_environment_variable", "filters": "?\\$filter=application%20eq%20" }, { @@ -786,7 +786,7 @@ "summary": "Create a fleet environment variable", "description": "", "method": "POST", - "endpoint": "/v6/application_environment_variable", + "endpoint": "/v7/application_environment_variable", "filters": "", "data": "{\n \"application\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n}" }, @@ -795,7 +795,7 @@ "summary": "Update a fleet environment variable", "description": "", "method": "PATCH", - "endpoint": "/v6/application_environment_variable()", + "endpoint": "/v7/application_environment_variable()", "filters": "", "data": "{\n \"value\": \"\"\n}" }, @@ -804,7 +804,7 @@ "summary": "Remove a fleet environment variable", "description": "", "method": "DELETE", - "endpoint": "/v6/application_environment_variable()", + "endpoint": "/v7/application_environment_variable()", "filters": "" } ] @@ -825,7 +825,7 @@ "summary": "Get all fleet service variables for a service", "description": "", "method": "GET", - "endpoint": "/v6/service_environment_variable", + "endpoint": "/v7/service_environment_variable", "filters": "?\\$filter=service%20eq%20" }, { @@ -833,7 +833,7 @@ "summary": "Create a fleet service variable", "description": "", "method": "POST", - "endpoint": "/v6/service_environment_variable", + "endpoint": "/v7/service_environment_variable", "filters": "", "data": "{\n \"service\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n}" }, @@ -842,7 +842,7 @@ "summary": "Update a device service variable", "description": "", "method": "PATCH", - "endpoint": "/v6/service_environment_variable()", + "endpoint": "/v7/service_environment_variable()", "filters": "", "data": "{\n \"value\": \"\"\n}" }, @@ -851,7 +851,7 @@ "summary": "Remove a fleet service variable", "description": "", "method": "DELETE", - "endpoint": "/v6/service_environment_variable()", + "endpoint": "/v7/service_environment_variable()", "filters": "" } ] @@ -875,7 +875,7 @@ "summary": "Get all organizations associated with authenticated user", "description": "", "method": "GET", - "endpoint": "/v6/organization", + "endpoint": "/v7/organization", "filters": "" }, { @@ -883,7 +883,7 @@ "summary": "Get organization by ID", "description": "", "method": "GET", - "endpoint": "/v6/organization()", + "endpoint": "/v7/organization()", "filters": "" }, { @@ -891,7 +891,7 @@ "summary": "Get organization by handle", "description": "Uniquely identifies an organization. Handles are currently automatically generated and read-only.", "method": "GET", - "endpoint": "/v6/organization(handle='')", + "endpoint": "/v7/organization(handle='')", "filters": "" } ] @@ -913,7 +913,7 @@ "summary": "Get all organization memberships", "description": "", "method": "GET", - "endpoint": "/v6/organization_membership", + "endpoint": "/v7/organization_membership", "filters": "" } ] @@ -953,7 +953,7 @@ "summary": "Get all releases for a fleet", "description": "", "method": "GET", - "endpoint": "/v6/release", + "endpoint": "/v7/release", "filters": "?\\$filter=belongs_to__application%20eq%20" }, { @@ -961,7 +961,7 @@ "summary": "Get the release raw_version field", "description": "The raw_version field is returned only when explicitly requested with $select.", "method": "GET", - "endpoint": "/v6/release()", + "endpoint": "/v7/release()", "filters": "?\\$select=raw_version" }, { @@ -969,7 +969,7 @@ "summary": "Get a release ID given a specific fleet and version", "description": "", "method": "GET", - "endpoint": "/v6/release", + "endpoint": "/v7/release", "filters": "?\\$filter=belongs_to__application%20eq%20%20and%20raw_version%20eq%20''&\\$select=id" }, { @@ -977,7 +977,7 @@ "summary": "Get a release ID given a specific fleet and commit", "description": "", "method": "GET", - "endpoint": "/v6/release", + "endpoint": "/v7/release", "filters": "?\\$filter=belongs_to__application%20eq%20%20and%20commit%20eq%20''&\\$select=id" } ] @@ -997,7 +997,7 @@ "summary": "Get all tags by release commit", "description": "", "method": "GET", - "endpoint": "/v6/release_tag", + "endpoint": "/v7/release_tag", "filters": "?\\$filter=release/commit%20eq%20''" }, { @@ -1005,7 +1005,7 @@ "summary": "Create a new release tag", "description": "", "method": "POST", - "endpoint": "/v6/release_tag", + "endpoint": "/v7/release_tag", "filters": "", "data": "{\n \"release\": \"\",\n \"tag_key\": \"\",\n \"value\": \"\"\n}" } @@ -1024,7 +1024,7 @@ "summary": "Get all supervisor releases for a specific cpu architecture by slug (eg amd64/rpi/armv7hf/aarch64)", "description": "To request a list of the supported supervisor releases for a particular cpu architecture, the `CPU_ARCHITECTURE_SLUG` parameter is required. Even though this query only selects the `id` and `raw_version` fields, you can additionally specify any of the fields found in the release resource. The Authorization header is optional.", "method": "GET", - "endpoint": "/v6/release", + "endpoint": "/v7/release", "filters": "?\\$select=id,raw_version&\\$filter=(status%20eq%20%27success%27)%20and%20(is_final%20eq%20true)%20and%20(is_invalidated%20eq%20false)%20and%20(semver_major%20gt%200)%20and%20(belongs_to__application/any(a:(startswith(a/slug,%27balena_os%2F%27)%20and%20endswith(a/slug,%27-supervisor%27))%20and%20((a/is_public%20eq%20true)%20and%20(a/is_host%20eq%20false)%20and%20(a/is_for__device_type/any(dt:dt/is_of__cpu_architecture/any(c:c/slug%20eq%20%27%27))))))&\\$orderby=semver_major%20desc,semver_minor%20desc,semver_patch%20desc,revision%20desc" }, { @@ -1032,7 +1032,7 @@ "summary": "Get all supervisor releases for a specific cpu architecture by ID", "description": "", "method": "GET", - "endpoint": "/v6/release", + "endpoint": "/v7/release", "filters": "?\\$select=id,raw_version&\\$filter=(status%20eq%20%27success%27)%20and%20(is_final%20eq%20true)%20and%20(is_invalidated%20eq%20false)%20and%20(semver_major%20gt%200)%20and%20(belongs_to__application/any(a:(startswith(a/slug,%27balena_os%2F%27)%20and%20endswith(a/slug,%27-supervisor%27))%20and%20((a/is_public%20eq%20true)%20and%20(a/is_host%20eq%20false)%20and%20(a/is_for__device_type/any(dt:dt/is_of__cpu_architecture%20eq%20)))))&\\$orderby=semver_major%20desc,semver_minor%20desc,semver_patch%20desc,revision%20desc" }, { @@ -1040,7 +1040,7 @@ "summary": "Get a specific supervisor release version for a specific cpu architecture", "description": "", "method": "GET", - "endpoint": "/v6/release", + "endpoint": "/v7/release", "filters": "?\\$select=id,raw_version&\\$filter=(status%20eq%20%27success%27)%20and%20(is_final%20eq%20true)%20and%20(is_invalidated%20eq%20false)%20and%20(semver_major%20gt%200)%20and%20(belongs_to__application/any(a:(startswith(a/slug,%27balena_os%2F%27)%20and%20endswith(a/slug,%27-supervisor%27))%20and%20((a/is_public%20eq%20true)%20and%20(a/is_host%20eq%20false)%20and%20(a/is_for__device_type/any(dt:dt/is_of__cpu_architecture/any(c:c/slug%20eq%20%27%27))))))%20and%20(raw_version%20eq%20%27%27)&\\$orderby=semver_major%20desc,semver_minor%20desc,semver_patch%20desc,revision%20desc" } ] @@ -1055,7 +1055,7 @@ "summary": "List the supported balenaOS versions for a device type", "description": "To request a list of the supported balenaOS versions for a particular device type, the `DEVICE TYPE SLUG` parameter is required. Even though this query only selects the `raw_version` field, you can additionally specify any of the fields found in the release resource. The Authorization header is optional.", "method": "GET", - "endpoint": "/v6/release", + "endpoint": "/v7/release", "filters": "?\\$select=raw_version&\\$filter=(is_final%20eq%20true)%20and%20(is_invalidated%20eq%20false)%20and%20(status%20eq%20'success')%20and%20(semver_major%20gt%200)%20and%20(belongs_to__application/any(bta:(bta/is_host%20eq%20true)%20and%20(bta/is_for__device_type/any(dt:dt/slug%20eq%20''))))&\\$orderby=semver_major%20desc,semver_minor%20desc,semver_patch%20desc,revision%20desc" }, { @@ -1063,7 +1063,7 @@ "summary": "List the supported balenaOS versions for a private device type", "description": "Same as above, but in order to access private device types, you must provide an authentication token.", "method": "GET", - "endpoint": "/v6/release", + "endpoint": "/v7/release", "filters": "?\\$select=raw_version&\\$filter=(is_final%20eq%20true)%20and%20(is_invalidated%20eq%20false)%20and%20(status%20eq%20'success')%20and%20(semver_major%20gt%200)%20and%20(belongs_to__application/any(bta:(bta/is_host%20eq%20true)%20and%20(bta/is_for__device_type/any(dt:dt/slug%20eq%20''))))&\\$orderby=semver_major%20desc,semver_minor%20desc,semver_patch%20desc,revision%20desc" } ] @@ -1109,7 +1109,7 @@ "summary": "Get all SSH keys", "description": "", "method": "GET", - "endpoint": "/v6/user__has__public_key", + "endpoint": "/v7/user__has__public_key", "filters": "" }, { @@ -1117,7 +1117,7 @@ "summary": "Get SSH key by ID", "description": "", "method": "GET", - "endpoint": "/v6/user__has__public_key()", + "endpoint": "/v7/user__has__public_key()", "filters": "" }, { @@ -1125,7 +1125,7 @@ "summary": "Add new SSH key to account", "description": "", "method": "POST", - "endpoint": "/v6/user__has__public_key", + "endpoint": "/v7/user__has__public_key", "filters": "", "data": "{\n \"public_key\": \"\",\n \"title\": \"\",\n \"user\": \"<USER ID>\"\n}" }, @@ -1134,7 +1134,7 @@ "summary": "Remove SSH key", "description": "", "method": "DELETE", - "endpoint": "/v6/user__has__public_key(<ID>)", + "endpoint": "/v7/user__has__public_key(<ID>)", "filters": "" } ] @@ -1154,7 +1154,7 @@ "summary": "Get all services belonging to a fleet", "description": "", "method": "GET", - "endpoint": "/v6/service", + "endpoint": "/v7/service", "filters": "?\\$filter=application/app_name%20eq%20'<FLEET NAME>'" } ] @@ -1174,7 +1174,7 @@ "summary": "Get service name for all services on a device", "description": "", "method": "GET", - "endpoint": "/v6/service_install", + "endpoint": "/v7/service_install", "filters": "?\\$filter=device/uuid%20eq%20'<DEVICE UUID>'&\\$expand=installs__service(\\$select=service_name)" } ] @@ -1194,7 +1194,7 @@ "summary": "Get users associated with account", "description": "", "method": "GET", - "endpoint": "/v6/user", + "endpoint": "/v7/user", "filters": "" }, { @@ -1202,7 +1202,7 @@ "summary": "Get users associated with fleet", "description": "", "method": "GET", - "endpoint": "/v6/user__is_member_of__application", + "endpoint": "/v7/user__is_member_of__application", "filters": "?\\$expand=user(\\$select=id,username,actor),application_membership_role(\\$select=id,name,actor)&\\$filter=is_member_of__application%20eq%20<ID>" }, { @@ -1210,7 +1210,7 @@ "summary": "Create fleet membership", "description": "", "method": "POST", - "endpoint": "/v6/user__is_member_of__application", + "endpoint": "/v7/user__is_member_of__application", "filters": "", "data": "{\n \"is_member_of_application\": <ID>,\n \"username\": \"<USERNAME>\",\n \"application_membership_role\": <ROLE ID>\n}" }, @@ -1219,7 +1219,7 @@ "summary": "Delete fleet membership", "description": "", "method": "DELETE", - "endpoint": "/v6/user__is_member_of__application(is_member_of__application=<ID>,user=<USER ID>)", + "endpoint": "/v7/user__is_member_of__application(is_member_of__application=<ID>,user=<USER ID>)", "filters": "" } ] @@ -1240,7 +1240,7 @@ "summary": "Get all teams associated with user", "description": "", "method": "GET", - "endpoint": "/v6/team", + "endpoint": "/v7/team", "filters": "" }, { @@ -1248,7 +1248,7 @@ "summary": "Get team by ID", "description": "", "method": "GET", - "endpoint": "/v6/team(<ID>)", + "endpoint": "/v7/team(<ID>)", "filters": "" }, { @@ -1256,7 +1256,7 @@ "summary": "Delete team with ID", "description": "", "method": "Delete", - "endpoint": "/v6/team(<ID>)", + "endpoint": "/v7/team(<ID>)", "filters": "" }, { @@ -1264,7 +1264,7 @@ "summary": "Create a new team in organization", "description": "", "method": "POST", - "endpoint": "/v6/team", + "endpoint": "/v7/team", "filters": "", "data": "{\n \"name\": \"<TEAM NAME>\",\n \"belongs_to__organization\": \"<ORG ID>\"\n}" } @@ -1286,7 +1286,7 @@ "summary": "Get Team's fleet access", "description": "", "method": "GET", - "endpoint": "/v6/team_application_access", + "endpoint": "/v7/team_application_access", "filters": "" } ] @@ -1306,7 +1306,7 @@ "summary": "Get team membership of users", "description": "", "method": "GET", - "endpoint": "/v6/team_membership", + "endpoint": "/v7/team_membership", "filters": "" } ]