project

Manage your Project

Examples

Create new project

rbx project create --name project --organizatiton MyCompany

project create

Create Project

Syntax

rbx project create | --name NAME --organisation ORGANISATION [--tag TAG [--tag TAG ...]]

Example

rbx project create create --name project --organizatiton MyCompany

Required arguments

Name Default Description
--name NAME ISO name
--organisation ORGANISATION Organisation ID or name

Optional arguments

Name Default Description
--tag TAG [--tag TAG ...] Key=value of tag. The parameter may occur repeatedly

project show

Show Project

Syntax

rbx project show | --project PROJECT

Example

rbx project show --project my-project

Required arguments

Name Default Description
--project PROJECT Project ID or name

project delete

Delete Project

Syntax

rbx project delete | --project PROJECT

Example

rbx project delete --project my-project

Required arguments

Name Default Description
--project PROJECT Project ID or name

project access

Manage your Project access rights

Optional arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default

project access grant

Grant access rights for Project

Syntax

rbx project access grant | --project PROJECT --email EMAIL [--role {owner,billing,user}]

Example

rbx project access grant --project my-project --email user@example.com

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default
--email EMAIL User email (eg: user@example.org)

Optional arguments

Name Default Description
--role {owner,billing,user} Role

project access revoke

Revoke access rights for Project

Syntax

rbx project access revoke | --project PROJECT --email EMAIL

Example

rbx project access revoke --project my-project --email user@example.com

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default
--email EMAIL User email (eg: user@example.org)

project access list

List access rights for Project

Syntax

rbx project access list | --project PROJECT

Example

rbx project access list --project my-project

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default

project history

History of Project

Syntax

rbx project history | --project PROJECT

Example

rbx project history --project my-project

Required arguments

Name Default Description
--project PROJECT Project ID or name

project rename

Rename Project

Syntax

rbx project rename | --project PROJECT --new-name NEW-NAME

Example

rbx project rename --project my-project --new-name my-renamed-project

Required arguments

Name Default Description
--project PROJECT Project ID or name
--new-name NEW-NAME New name

project service

Manage your services of Project

project service list

List Service for Project

Syntax

rbx project service list | --project PROJECT

Example

rbx project service list --project test-project

Required arguments

Name Default Description
--project PROJECT Project ID or name

project service show

Show Service for Project

Syntax

rbx project service show | --project PROJECT --service SERVICE

Example

rbx project service show --service my-service --project my-project

Required arguments

Name Default Description
--project PROJECT Project ID or name
--service SERVICE Service for Project ID or name

project payment

Manage your payment for Project

project payment show

Show payment

Syntax

rbx project payment show | --project PROJECT --payment PAYMENT

Example

rbx project payment show --payment my-payment --Project my-Project

Required arguments

Name Default Description
--project PROJECT Project ID or name
--payment PAYMENT Payment ID or name

project payment list

List payment

Syntax

rbx project payment list | --project PROJECT

Example

rbx project payment list --Project my-Project

Required arguments

Name Default Description
--project PROJECT Project ID or name

project list

List Project

Syntax

rbx project list | [--all]

Example

rbx project list

Optional arguments

Name Default Description
--all Include inactive projects

project transfer

Transfer Project to other organisation

Syntax

rbx project transfer | --project PROJECT --organisation ORGANISATION

Example

rbx project transfer --project test-project --organisation target-organisation

Required arguments

Name Default Description
--project PROJECT Project ID or name
--organisation ORGANISATION New organisation

project token

Manage your Project tokens

Examples

Create a token

rbx project token add --project 6oAoJqgyLZP4Le9UUNHrEOYP --name secret-token-1

Grant access to token for snapshots of selected Vault

rbx project token access add --project 6oAoJqgyLZP4Le9UUNHrEOYP --method POST --path 'vault/x/actions/snapshot' --token d41d8cd98f00b204e9800998ecf8427e

Verify access of token

rbx project token access list --project 6oAoJqgyLZP4Le9UUNHrEOYP \
    --token d41d8cd98f00b204e9800998ecf8427e

Remove some access of token

rbx project token access delete --project 6oAoJqgyLZP4Le9UUNHrEOYP --token d41d8cd98f00b204e9800998ecf8427e --access c4ca4238a0b923820dcc509a6f75849b

Perform a snapshot of Vault using API token

ROOTBOX_ACCESS_TOKEN_SECRET="d41d8cd98f00b204e9800998ecf8427e" rbx vault snapshot --vault x --name $(date +"%s")

project token show

Show Token

Syntax

rbx project token show | --project PROJECT --token TOKEN

Example

rbx project token show --token my-token

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default
--token TOKEN Token ID or name

project token list

List Token

Syntax

rbx project token list | --project PROJECT

Example

rbx project token list

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default

project token delete

Delete Token

Syntax

rbx project token delete | --project PROJECT --token TOKEN

Example

rbx project token delete --token my-token --project my-project

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default
--token TOKEN Token ID or name

project token rename

Rename Token

Syntax

rbx project token rename | --project PROJECT --token TOKEN --new-name NEW-NAME

Example

rbx project token rename --token my-token --new-name my-renamed-token

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default
--token TOKEN Token ID or name
--new-name NEW-NAME New name

project token add

Add Token

Syntax

rbx project token add | --project PROJECT --name NAME

Example

rbx project token add --project 6oAoJqgyLZP4Le9UUNHrEOYP --name secret-token-1

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default
--name NAME Name

project token access

Manage your token access

project token access list

List access rule

Syntax

rbx project token access list | --project PROJECT --token TOKEN

Example

rbx project token access list --project my-project --token my-token --access my-access-id

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default
--token TOKEN Token ID

project token access show

Show access rule

Syntax

rbx project token access show | --project PROJECT --token TOKEN --access ACCESS

Example

rbx project token access show --access my-access

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default
--token TOKEN Token ID
--access ACCESS Access rule ID or name

project token access delete

Delete access rule

Syntax

rbx project token access delete | --project PROJECT --token TOKEN --access ACCESS

Example

rbx project token access delete --access my-access --project my-project --token my-token --access my-access-id

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default
--token TOKEN Token ID
--access ACCESS Access rule ID or name

project token access add

Add access rule

Syntax

rbx project token access add | --method METHOD --path PATH --project PROJECT --token TOKEN

Examples

Grant access to token for snapshots of selected Vault

rbx project token access add --project 6oAoJqgyLZP4Le9UUNHrEOYP --method POST --path 'vault/x/actions/snapshot' --token d41d8cd98f00b204e9800998ecf8427e

Required arguments

Name Default Description
--method METHOD HTTP method. eg: GET, POST..., ALL (to allow all methods)
--path PATH URL path, eg: /disk
--project PROJECT Project ID or name. Active project by default
--token TOKEN Token ID

project token env

Get environment variables to manage project by service account

Syntax

rbx project token env | --project PROJECT --token TOKEN [--shell {powershell,cmd,sh,bash}] [--unset]

Examples

Get and set environment variables in sh/bash shell

eval $(rbx project token env --token 189d9053248c4f6fbacebe90558ff538)

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default
--token TOKEN Token ID

Optional arguments

Name Default Description
--shell {powershell,cmd,sh,bash} Shell type
--unset Reverses operations of setting environment variables

project notification

Manage your notifications

project notification credits

Manage your credits limit

project notification credits add

Add credits limit

Syntax

rbx project notification credits add | --project PROJECT --limit LIMIT

Example

rbx project notification credits add --project my-project --limit value

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default
--limit LIMIT New credits limit

project notification credits list

List credits limit

Syntax

rbx project notification credits list | --project PROJECT

Example

rbx project notification credits list --project my-project

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default

project notification credits delete

Delete credits limit

Syntax

rbx project notification credits delete | --project PROJECT --limit LIMIT

Example

rbx project notification credits delete --project my-project --limit value

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default
--limit LIMIT Deleted credits limit

project select

Select Project context

Syntax

rbx project select | --project PROJECT

Example

rbx project select --project 6oAoJqgyLZP4Le9UUNHrEOYP

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default

project limit

Cloud limits set for project

Syntax

rbx project limit | --project PROJECT

Example

rbx project limit --project 6oAoJqgyLZP4Le9UUNHrEOYP

Contact technical support to request increase the limits.

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default

project credentials

Manage your credentials

project credentials show

Show credentials

Syntax

rbx project credentials show | --project PROJECT --credentials CREDENTIALS

Example

rbx project credentials show --credentials my-credentials

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default
--credentials CREDENTIALS Credentials ID or name

project credentials list

List credentials

Syntax

rbx project credentials list | --project PROJECT

Example

rbx project credentials list --project my-project

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default

project credentials delete

Delete credentials

Syntax

rbx project credentials delete | --project PROJECT --credentials CREDENTIALS

Example

rbx project credentials delete --credentials my-credentials --project my-project

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default
--credentials CREDENTIALS Credentials ID or name

project credentials rename

Rename credentials

Syntax

rbx project credentials rename | --project PROJECT --credentials CREDENTIALS --new-name NEW-NAME

Example

rbx project credentials rename --credentials my-credentials --new-name my-renamed-credentials --project my-project

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default
--credentials CREDENTIALS Credentials ID or name
--new-name NEW-NAME New name

project credentials add

Add public SSH key for Project

Syntax

rbx project credentials add | --project PROJECT --name NAME --sshkey-file SSHKEY-FILE

Example

rbx project credentials add --name my-home-ssh --sshkey-file ~/.ssh/id_rsa.pub --project my-project

Required arguments

Name Default Description
--project PROJECT Project ID or name. Active project by default
--name NAME Name
--sshkey-file SSHKEY-FILE Public SSH key filename

project tag

Manage your tag

project tag list

List tag

Syntax

rbx project tag list | --project PROJECT

Example

rbx project tag list --project my-project

Required arguments

Name Default Description
--project PROJECT Project ID or name

project tag add

Add a tag to Project

Syntax

rbx project tag add | --tag TAG [--tag TAG ...] --project PROJECT

Example

rbx project tag add --project test-project --tag prod=true

Required arguments

Name Default Description
--tag TAG [--tag TAG ...] Key=value of tag. The parameter may occur repeatedly
--project PROJECT Project ID or name

project tag delete

Delete a tag of Project

Syntax

rbx project tag delete | --tag TAG --project PROJECT

Example

rbx project tag delete --project test-project --tag prod

Required arguments

Name Default Description
--tag TAG Tag
--project PROJECT Project ID or name
Czy uważasz ten artykuł za przydatny? Tak Nie