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

# \AccountManagementApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**starred_domain_add**](AccountManagementApi.md#starred_domain_add) | **PUT** /global/starred-domains/{domainID} | Adds to starred domains
[**starred_domain_list**](AccountManagementApi.md#starred_domain_list) | **GET** /global/starred-domains | List the user's starred domains
[**starred_domain_remove**](AccountManagementApi.md#starred_domain_remove) | **DELETE** /global/starred-domains/{domainID} | Removes from starred domains



## starred_domain_add

> starred_domain_add(domain_id, body)
Adds to starred domains

Adds the domain to the list of starred domains for the user.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**domain_id** | **String** |  | [required] |
**body** | **serde_json::Value** |  | [required] |

### Return type

 (empty response body)

### Authorization

[oauth_token](../README.md#oauth_token)

### 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)


## starred_domain_list

> models::StarredDomainList starred_domain_list()
List the user's starred domains

Returns a list of domains that the user has starred. This is a list of domain IDs, not domain names. The user must be authenticated to call this method. 

### Parameters

This endpoint does not need any parameter.

### Return type

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

### Authorization

[oauth_token](../README.md#oauth_token)

### 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)


## starred_domain_remove

> starred_domain_remove(domain_id)
Removes from starred domains

Removes the domain from the list of starred domains for the user.

### Parameters


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

### Return type

 (empty response body)

### Authorization

[oauth_token](../README.md#oauth_token)

### 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)