Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

sylphx access projects

Every sylphx access projects command: its argument, its flags and a run line.

The projects commands of Sylphx Access, as the CLI spells them: the same calls as the projects API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

#get

Gets a project.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx access projects get orgs/acme/projects/shop

GET https://api.sylphx.com/v1/orgs/acme/projects/shop · scope access:read · effect read · Request, response and examples

#list

Lists projects in an org.

PARENT — optional: the CLI fills it from the linked project or the key's scope when it is left out.

CLI

Shell
sylphx access projects list orgs/acme

GET https://api.sylphx.com/v1/orgs/acme/projects · scope access:read · effect read · Request, response and examples

Flags

FlagTypeWhat it does
--page-sizeintAt most this many; default 50, clamped to 1000.
--page-tokenstringnext_page_token of the previous page.
--filterstringAIP-160 filter over labels, filterable spec fields, and Ready.
--order-bystringAIP-132 ordering over filterable fields.

#create

Creates a project. Access assigns the id.

CLI

Shell
sylphx access projects create --parent orgs/acme --spec.slug …

POST https://api.sylphx.com/v1/orgs/acme/projects · scope access:admin · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--parentstringThe parent to create in; defaults to the linked project or the key's scope.
--meta.labelskey=valueCaller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
--meta.annotationskey=valueCaller-writable, unindexed annotations. Repeat the flag for each value.
--meta.display-namestringCaller-writable human-readable name.
--spec.slugstringUnique within the org. Required.
--dry-runboolValidate and print the result without writing (validate_only).

#update

Updates a project.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx access projects update orgs/acme/projects/shop --spec.slug …

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop · scope access:admin · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--meta.labelskey=valueCaller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
--meta.annotationskey=valueCaller-writable, unindexed annotations. Repeat the flag for each value.
--meta.display-namestringCaller-writable human-readable name.
--spec.slugstringUnique within the org. Required.
--dry-runboolValidate and print the result without writing (validate_only).

#delete

Deletes a project.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx access projects delete orgs/acme/projects/shop --yes

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop · scope access:admin · effect destructive · Request, response and examples

Flags

FlagTypeWhat it does
--etagstringDelete only if the current etag matches.
--dry-runboolValidate and print the result without writing (validate_only).
--forceboolAlso delete every child Resource; without it a parent with children fails with FAILED_PRECONDITION.
--yesboolDo not ask before this destructive call.