Get site by ID

GET

/api/sites/{id}

const url = 'https://example.com/api/sites/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/sites/example \
  --header 'Authorization: Bearer <token>'

Retrieves a specific site and its data

Authorizations

bearerAuth

Parameters

Path Parameters

required

Site ID

string

Responses

200

Site retrieved successfully

application/json

object

required

Site ID

string

name

required

Site name

string

description

Site description

string

url

Site URL

string

repositories

Connected repository IDs

Array<string>

createdAt

Creation timestamp

number

updatedAt

Last update timestamp

number

readPerm

Roles with read permission

Array<string>

default:

writePerm

Roles with write permission

Array<string>

default:

deletePerm

Roles with delete permission

Array<string>

default:

Example

{
  "id": "site-123",
  "name": "Marketing Site",
  "url": "https://example.com",
  "readPerm": [],
  "writePerm": [],
  "deletePerm": []
}