graviti.openapi.workspace#

Interfaces about the workspace.

Module Contents#

Functions#

get_current_workspace(access_key, url)

Execute the OpenAPI GET /v2/current-workspace.

get_workspace(access_key, url, workspace)

Execute the OpenAPI GET /v2/workspaces/{workspace}.
graviti.openapi.workspace.get_current_workspace(access_key, url)[source]#

Execute the OpenAPI GET /v2/current-workspace.

Parameters

  • access_key (str) – User’s access key.

  • url (str) – The URL of the graviti website.

Returns

The response of OpenAPI.

Return type

Dict[str, Any]

Examples

>>> get_current_workspace("ACCESSKEY-********", "https://api.graviti.com")
{
    "type": "TEAM",
    "id": "41438e9df9a82a194e1e76cc31c1d8d4",
    "name": "portex-test",
    "alias": "PortexTest",
    "description": "xxx",
    "email": "xxxx@xx.com",
    "location": "xxx",
}
graviti.openapi.workspace.get_workspace(access_key, url, workspace)[source]#

Execute the OpenAPI GET /v2/workspaces/{workspace}.

Parameters

  • access_key (str) – User’s access key.

  • url (str) – The URL of the graviti website.

  • workspace (str) – The name of the workspace.

Returns

The response of OpenAPI.

Return type

Dict[str, Any]

Examples

>>> get_workspace("ACCESSKEY-********", "https://api.graviti.com", "portex-test")
{
    "type": "TEAM",
    "id": "41438e9df9a82a194e1e76cc31c1d8d4",
    "name": "portex-test",
    "alias": "PortexTest",
    "description": "xxx",
    "email": "xxxx@xx.com",
    "location": "xxx",
}