antimatter_api 2.0.13

Interact with the Antimatter Cloud API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

# \KeychainApi

All URIs are relative to *https://api.antimatter.io/v2*

Method | HTTP request | Description
------------- | ------------- | -------------
[**keychain_create_workspace**](KeychainApi.md#keychain_create_workspace) | **POST** /keychain/workspaces | Create a workspace
[**keychain_get_workspace_info**](KeychainApi.md#keychain_get_workspace_info) | **GET** /keychain/workspaces/{workspace}/info | Get information about a workspace
[**keychain_get_workspace_objects**](KeychainApi.md#keychain_get_workspace_objects) | **GET** /keychain/workspaces/{workspace}/objects | Get a batch of objects in a workspace
[**keychain_put_workspace_objects**](KeychainApi.md#keychain_put_workspace_objects) | **POST** /keychain/workspaces/{workspace}/objects | Put a batch of objects in a workspace



## keychain_create_workspace

> models::WorkspaceInfo keychain_create_workspace(new_workspace)
Create a workspace

Creates a new keychain workspace 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**new_workspace** | [**NewWorkspace**](NewWorkspace.md) |  | [required] |

### Return type

[**models::WorkspaceInfo**](WorkspaceInfo.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## keychain_get_workspace_info

> models::WorkspaceInfo keychain_get_workspace_info(workspace)
Get information about a workspace

This endpoint allows you to fetch information about a workspace 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |

### Return type

[**models::WorkspaceInfo**](WorkspaceInfo.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## keychain_get_workspace_objects

> models::WorkspaceObjectList keychain_get_workspace_objects(workspace, from)
Get a batch of objects in a workspace

This endpoint allows you to fetch a set of objects in a workspace 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**from** | **String** | From which object ID to fetch a batch of objects | [required] |

### Return type

[**models::WorkspaceObjectList**](WorkspaceObjectList.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## keychain_put_workspace_objects

> keychain_put_workspace_objects(workspace, new_workspace_objects)
Put a batch of objects in a workspace

This endpoint allows you to place a set of objects in a workspace 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**new_workspace_objects** | [**NewWorkspaceObjects**](NewWorkspaceObjects.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)