OPopal
apps

Set app visibility

Changed on

Sets the visibility of this app. Preferred over setting visibility / visibility_group_ids / import_visibility inline on POST /apps or PATCH /apps/{app_id} for drift-sensitive callers (Terraform, GitOps). Semantics are a replace, not a merge: visibility_group_ids is written to exactly what the request sends (an omitted or empty array clears all groups), and import_visibility is updated only when present.

put/apps/{app_id}/visibility

Request

  • Base URL
    https://api.opal.dev/v1
  • Auth
    HTTP bearer

Path parameters

app_idstring uuid required

The ID of the app.

Request body

visibility'GLOBAL' | 'LIMITED' required

The visibility level of the entity.

visibility_group_idsstring[]

The IDs of groups that can see this app when visibility is LIMITED. Must be empty when visibility is GLOBAL.

import_visibility'GLOBAL' | 'LIMITED'

The visibility level of the entity.

Example request

{
  "visibility": "LIMITED",
  "visibility_group_ids": [
    "7870617d-e72a-47f5-a84c-693817ab4567",
    "1520617d-e72a-47f5-a84c-693817ab48ad"
  ],
  "import_visibility": "LIMITED"
}

Response

The updated visibility info of this app.

visibility'GLOBAL' | 'LIMITED' required

The visibility level of the entity.

visibility_group_idsstring[]

The IDs of groups that can see this app when visibility is LIMITED. Must be empty when visibility is GLOBAL.

import_visibility'GLOBAL' | 'LIMITED'

The visibility level of the entity.

Example response

{
  "visibility": "LIMITED",
  "visibility_group_ids": [
    "7870617d-e72a-47f5-a84c-693817ab4567",
    "1520617d-e72a-47f5-a84c-693817ab48ad"
  ],
  "import_visibility": "LIMITED"
}

Changes