그룹 조회
조직이나 사용자 계정에 속한 그룹 하나의 정보를 가져오는 API예요. 이름, 위치, UUID 같은 그룹 상세가 궁금할 때 사용해요.
출처: 문서
본문
조직이나 사용자에 속한 그룹을 반환해요.
curl -L 'https://api.turso.tech/v1/organizations/{organizationSlug}/groups/{groupName}' \
-H 'Authorization: Bearer ***'
import { createClient } from "@tursodatabase/api";
const turso = createClient({
org: "...",
token: "",
});
const group = await turso.groups.retrieve("default");
OpenAPI
openapi: 3.0.1
info:
title: Turso Platform API
description: API description here
license:
name: MIT
version: 0.1.0
servers:
- url: https://api.turso.tech
description: Turso's Platform API
security: []
paths:
/v1/organizations/{organizationSlug}/groups/{groupName}:
get:
summary: Retrieve Group
description: Returns a group belonging to the organization or user.
operationId: getGroup
parameters:
- $ref: '#/components/parameters/organizationSlug'
- $ref: '#/components/parameters/groupName'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
group:
$ref: '#/components/schemas/Group'
'404':
$ref: '#/components/responses/GroupNotFoundResponse'
components:
parameters:
organizationSlug:
in: path
name: organizationSlug
required: true
schema:
type: string
description: The slug of the organization or user account.
groupName:
name: groupName
in: path
required: true
schema:
type: string
description: The name of the group.
schemas:
Group:
allOf:
- $ref: '#/components/schemas/BaseGroup'
- type: object
BaseGroup:
type: object
properties:
name:
type: string
description: The group name, unique across your organization.
example: default
version:
type: string
description: >-
The current libSQL server version the databases in that group are
running.
example: v0.23.7
deprecated: true
uuid:
type: string
description: The group universal unique identifier (UUID).
example: 0a28102d-6906-11ee-8553-eaa7715aeaf2
locations:
type: array
items:
type: string
description: An array of location keys the group is located.
example:
- aws-us-east-1
deprecated: true
primary:
type: string
description: The primary location key.
example: us-east-1
delete_protection:
type: boolean
description: >-
The current status for delete protection. If enabled, the group and
all its databases cannot be deleted.
example: false
responses:
GroupNotFoundResponse:
description: Group not found
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: The error message
example: group not found