Skip to main content

wf get

wf get

Retrieves resources


Allows you to retrieve resources. If no name is provided a list of all resources of the specified type will be returned.

Examples of resource types are users, workspaces, clusters. You can list all available resource types using:

$ wf api-resources

For a better experience resource types can be auto-completed for you, find out more by running:

$ wf completion

wf get [flags]


# List users
$ wf get users

# Get information about a specific user
$ wf get user testuser

# Get information about a specific user, formatted in yaml
$ wf get user testuser -o yaml

# List all clusters in a specified workspace
$ wf get clusters -w lovely-workspace


  -A, --all-workspaces   Retrieve resources across all workspaces (subject to permissions)
--global Get global resources (for dual-scoped resource types) even if a default workspace is set
-h, --help help for get
--raw string Raw URI to request from the server

Options inherited from parent commands

      --debug              Debug / trace logging (default: false)
--force Force operation to happen (default: false)
--no-wait Do not wait for resources to provision
-o, --output string Output format of the resource (json,yaml,table,template) (default "table")
--profile string Use a profile other than your current - to change current: wf use profile NAME
--show-headers Display headers on table out (default true)
--verbose Verbose logging (default: false)
-w, --workspace string Workspace to use