Sign in

v1

latestOpenAPI 3.0.3AGPL-3.0-only2026-07-17120116247.0 KB
groups

Find groups by name

Returns the group with the given name if it exists.

get/groups/{name}

Query parameters

confidential_datainteger

If set to 1 confidential data will not be hidden. This means that the response will contain the key and additional data for secrets. If a master key is not set or an external KMS is used, the data returned are enough to get the secrets in cleartext. Ignored if the * permission is not granted.

Response

successful operation

idinteger
namestring

name is unique

descriptionstring

optional description

created_atinteger

creation time as unix timestamp in milliseconds

updated_atinteger

last update time as unix timestamp in milliseconds

usersstring[]

list of usernames associated with this group

adminsstring[]

list of admins usernames associated with this group

Example response

{
  "user_settings": {
    "permissions": {
      "/": [
        "*"
      ],
      "/somedir": [
        "list",
        "download"
      ]
    },
    "filters": {
      "allowed_ip": [
        "192.0.2.0/24",
        "2001:db8::/32"
      ],
      "denied_ip": [
        "172.16.0.0/16"
      ],
      "file_patterns": [
        {
          "allowed_patterns": [
            "*.jpg",
            "a*b?.png"
          ],
          "denied_patterns": [
            "*.zip"
          ]
        }
      ]
    },
    "filesystem": {
      "s3config": {
        "key_prefix": "folder/subfolder/"
      },
      "gcsconfig": {
        "key_prefix": "folder/subfolder/"
      },
      "azblobconfig": {
        "key_prefix": "folder/subfolder/"
      },
      "sftpconfig": {
        "buffer_size": 2
      }
    }
  },
  "virtual_folders": [
    {
      "filesystem": {
        "s3config": {
          "key_prefix": "folder/subfolder/"
        },
        "gcsconfig": {
          "key_prefix": "folder/subfolder/"
        },
        "azblobconfig": {
          "key_prefix": "folder/subfolder/"
        },
        "sftpconfig": {
          "buffer_size": 2
        }
      }
    }
  ]
}