Skip to content

ServerResource

API Access class for the server

Source code in src/specklepy/api/resources/current/server_resource.py 
11
12
13
14
15
16
def __init__(self, account, basepath, client) -> None:
    super().__init__(
        account=account,
        basepath=basepath,
        client=client,
    )

get 

get() -> ServerInfo

Get the server info

Returns:

Type Description
ServerInfo

dict -- the server info in dictionary form
Source code in src/specklepy/api/resources/current/server_resource.py 
18
19
20
21
22
23
24
25
def get(self) -> ServerInfo:
    """Get the server info

    Returns:
        dict -- the server info in dictionary form
    """
    metrics.track(metrics.SDK, self.account, {"name": "Server Get"})
    return super().get()

version 

version() -> Tuple[Any, ...]

Get the server version

Returns:

Type Description
Any

the server version in the format (major, minor, patch, (tag, build))
...

eg (2, 6, 3) for a stable build and (2, 6, 4, 'alpha', 4711) for alpha
Source code in src/specklepy/api/resources/current/server_resource.py 
27
28
29
30
31
32
33
34
35
36
def version(self) -> Tuple[Any, ...]:
    """Get the server version

    Returns:
        the server version in the format (major, minor, patch, (tag, build))
        eg (2, 6, 3) for a stable build and (2, 6, 4, 'alpha', 4711) for alpha
    """
    # not tracking as it will be called along with other
    # mutations / queries as a check
    return super().version()

apps 

apps() -> Dict

Get the apps registered on the server

Returns:

Type Description
Dict

dict -- a dictionary of apps registered on the server
Source code in src/specklepy/api/resources/current/server_resource.py 
38
39
40
41
42
43
44
45
def apps(self) -> Dict:
    """Get the apps registered on the server

    Returns:
        dict -- a dictionary of apps registered on the server
    """
    metrics.track(metrics.SDK, self.account, {"name": "Server Apps"})
    return super().apps()

create_token 

create_token(
    name: str, scopes: List[str], lifespan: int
) -> str

Create a personal API token

Returns:

Type Description
str

str -- the new API token. note: this is the only time you'll see the token!
Source code in src/specklepy/api/resources/current/server_resource.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
def create_token(self, name: str, scopes: List[str], lifespan: int) -> str:
    """Create a personal API token

    Arguments:
        scopes {List[str]} -- the scopes to grant with this token
        name {str} -- a name for your new token
        lifespan {int} -- duration before the token expires

    Returns:
        str -- the new API token. note: this is the only time you'll see the token!
    """
    metrics.track(metrics.SDK, self.account, {"name": "Server Create Token"})
    return super().create_token(name, scopes, lifespan)

revoke_token 

revoke_token(token: str) -> bool

Revokes (deletes) a personal API token

Returns:

Type Description
bool

bool -- True if the token was successfully deleted
Source code in src/specklepy/api/resources/current/server_resource.py 
61
62
63
64
65
66
67
68
69
70
71
def revoke_token(self, token: str) -> bool:
    """Revokes (deletes) a personal API token

    Arguments:
        token {str} -- the token to revoke (delete)

    Returns:
        bool -- True if the token was successfully deleted
    """
    metrics.track(metrics.SDK, self.account, {"name": "Server Revoke Token"})
    return super().revoke_token(token)