Skip to Content
kosemdocs
ReferenceAPISites

Get site

Gets a site.

GET
/v1/projects/{project}/sites/{site}

Gets a site.

Authorization

bearer
headerAuthorizationBearer <token>

An access token, or an API key.

Path Parameters

project*string

The project's ID.

Match^prj_[0-7][0-9a-hjkmnp-tv-z]{25}$
site*string

The site's ID.

Match^sit_[0-7][0-9a-hjkmnp-tv-z]{25}$

Response Body

OK

application/json
  1. response
agent*string

The agent that made the site, if one did, by its resource name.

createTime*string

When the site was made.

Formatdate-time
creator*string

Who made the site, as a member such as agent:{agent_id}.

displayName*string

What people call the site, at most 100 characters.

etag*string

Changes with each update. Send it back when updating the site; the update fails with aborted if the site changed in between.

liveVersion*string

The version the site serves, by its resource name: publishing sets it, and an update makes an older version live again. Empty while none is live.

name*string

Resource name, projects/{project_id}/sites/{site_id}.

restricted*boolean

Whether the roles on the project reach the site only for those who also hold sites.sites.accessPrivate there, its owners and Sites Admins, as while the agent that made it is private: then people who may see that agent open it, with those its own IAM policy names. It follows the agent's visibility, and only kosem changes it.

updateTime*string

When the site, or the version it serves, last changed.

Formatdate-time
uri*string

The site's address, https://{host}.{domain}/ under the sites' domain, whose host is the site's alone.

visibility*string

Who may open the site: PRIVATE, people who may see it, after signing in to kosem; PUBLIC, anyone with its link. Private when the site is made.

Value in"PRIVATE""PUBLIC"
Example Request
curl -X GET 'https://api.kosem.ai/v1/projects/string/sites/string'
Example Response
{
  "agent": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "creator": "string",
  "displayName": "string",
  "etag": "string",
  "liveVersion": "string",
  "name": "string",
  "restricted": true,
  "updateTime": "2019-08-24T14:15:22Z",
  "uri": "string",
  "visibility": "PRIVATE"
}