Skip to content

by Startups.Studio

Product Domains and access Domain

Domain.get

GET /{namespace}/domains/{id}

Returns one Domain by id.

Noun: Domain
Mode: read

You, to your agent

Show me the latest domain.

curl https://api.sb/quietcopy.com/domains/domain_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const domain = await $.Domain.get({ id: 'domain_1' })

npx startup-builder do Domain.get --json '{"id":"domain_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Domain.get({ id: 'domain_1' })"
  }
}

Get returns one Domain by id. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Domain.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Outputs

Output	Type	Required	Description
`domain`	Domain	required	The Domain.

Effects

Reads only: it emits no Event and changes nothing.
Read: try, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Domain.get

When it waits

Never: a read runs at once.

Domain.delete

Previous Page

Domain.list

Next Page