graphql-api
Manage GraphQL APIs
Authentication scope: fabric
List GraphQL APIs in a workspace
fabio graphql-api list --workspace <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
Read-only · Returns list
Show details of a GraphQL API
fabio graphql-api show --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | GraphQL API ID |
Read-only · Returns object
create
Section titled “create”Create a new GraphQL API
fabio graphql-api create --workspace <value> --name <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--name |
string |
Yes | Display name |
--description |
string |
No | Optional description |
--sensitivity-label |
string |
No | Sensitivity label ID to apply on creation |
Mutates state · Returns object
update
Section titled “update”Update GraphQL API properties (name and/or description)
fabio graphql-api update --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | GraphQL API ID |
--name |
string |
No | New display name |
--description |
string |
No | New description |
Mutates state · Returns object
delete
Section titled “delete”Delete a GraphQL API
fabio graphql-api delete --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | GraphQL API ID |
--hard-delete |
bool |
No | Permanently delete (cannot be recovered) |
Mutates state · Destructive · Returns void
get-definition
Section titled “get-definition”Get the definition of a GraphQL API
fabio graphql-api get-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | GraphQL API ID |
--decode |
bool |
No | Decode base64 payloads inline (adds decodedPayload field) |
Read-only · Long-running operation · Returns object
update-definition
Section titled “update-definition”Update the definition of a GraphQL API
fabio graphql-api update-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | GraphQL API ID |
--file |
string |
No | GraphQL schema file path (reads file content) |
--content |
string |
No | GraphQL schema content (inline) |
Mutates state · Long-running operation · Returns void
Execute a GraphQL query against a GraphQL API
fabio graphql-api query --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | GraphQL API ID |
--gql |
string |
No | GraphQL query text (use @file.graphql to read from file, or pipe via stdin) |
--variables |
string |
No | JSON-encoded variables for the query |
--operation-name |
string |
No | Operation name (for multi-operation documents) |
Read-only · Returns object