File size: 5,552 Bytes
a052b68
d0954af
a052b68
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d0954af
a052b68
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d0954af
a052b68
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d0954af
a052b68
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d0954af
a052b68
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
d0954af
a052b68
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
TITLE: Create new credentials for a database
URL:
============================================================

Create new credentials for a database

Create a new API key for a database.

Supports read , write , read-write privileges for CORE databases. Defaults to read-write .

read

write

read-write

read-write

publicOauth2 update:database

A cluster ID.

Create cluster credentials request

A list of privileges granted to these credentials

Password to be used for these credentials

New cluster credentials. Note: This is the only time the password is returned. If the password is lost new credentials should be generated.

ID uniquely identifying the request/response cycle.

Unique identifier for this resource within Halyard Cloud

A list of privileges granted to these credentials

The status of a user credential

Timestamp when the resource was created

Password to be used for these credentials

Invalid input

ID uniquely identifying the request/response cycle.

RFC 9457 Problem Details for HTTP APIs.
Provides a standardized format for conveying error details in HTTP responses.

URN-based error type identifiers following the pattern:
urn:halyard:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided
in the ProblemDetails context field, not in the URN.

A short, human-readable summary of the problem type

The HTTP status code

A human-readable explanation specific to this occurrence

A URI reference that identifies the specific occurrence

object

object

object

Context for resource-related errors (not-found, already-exists)

Type of resource (e.g., cluster, database, organization)

Identifier of the resource

Structured context for validation errors

JSON Pointer paths to missing required fields

Details about invalid field values

JSON Pointer path to the invalid field

URN identifying the specific validation error type

An optional human-readable description of the validation error

Developer-friendly message explaining the error.
Deprecated: Use ‘detail’ field instead.

Access token is missing or invalid

ID uniquely identifying the request/response cycle.

RFC 9457 Problem Details for HTTP APIs.
Provides a standardized format for conveying error details in HTTP responses.

URN-based error type identifiers following the pattern:
urn:halyard:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided
in the ProblemDetails context field, not in the URN.

A short, human-readable summary of the problem type

The HTTP status code

A human-readable explanation specific to this occurrence

A URI reference that identifies the specific occurrence

object

object

object

Context for resource-related errors (not-found, already-exists)

Type of resource (e.g., cluster, database, organization)

Identifier of the resource

Structured context for validation errors

JSON Pointer paths to missing required fields

Details about invalid field values

JSON Pointer path to the invalid field

URN identifying the specific validation error type

An optional human-readable description of the validation error

Developer-friendly message explaining the error.
Deprecated: Use ‘detail’ field instead.

Permission denied

ID uniquely identifying the request/response cycle.

RFC 9457 Problem Details for HTTP APIs.
Provides a standardized format for conveying error details in HTTP responses.

URN-based error type identifiers following the pattern:
urn:halyard:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided
in the ProblemDetails context field, not in the URN.

A short, human-readable summary of the problem type

The HTTP status code

A human-readable explanation specific to this occurrence

A URI reference that identifies the specific occurrence

object

object

object

Context for resource-related errors (not-found, already-exists)

Type of resource (e.g., cluster, database, organization)

Identifier of the resource

Structured context for validation errors

JSON Pointer paths to missing required fields

Details about invalid field values

JSON Pointer path to the invalid field

URN identifying the specific validation error type

An optional human-readable description of the validation error

Developer-friendly message explaining the error.
Deprecated: Use ‘detail’ field instead.

Internal Server Error

ID uniquely identifying the request/response cycle.

RFC 9457 Problem Details for HTTP APIs.
Provides a standardized format for conveying error details in HTTP responses.

URN-based error type identifiers following the pattern:
urn:halyard:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided
in the ProblemDetails context field, not in the URN.

A short, human-readable summary of the problem type

The HTTP status code

A human-readable explanation specific to this occurrence

A URI reference that identifies the specific occurrence

object

object

object

Context for resource-related errors (not-found, already-exists)

Type of resource (e.g., cluster, database, organization)

Identifier of the resource

Structured context for validation errors

JSON Pointer paths to missing required fields

Details about invalid field values

JSON Pointer path to the invalid field

URN identifying the specific validation error type

An optional human-readable description of the validation error

Developer-friendly message explaining the error.
Deprecated: Use ‘detail’ field instead.