Skip to content

Commit 33dada7

Browse files
authored
Merge pull request #2988 from replicatedhq/118836
add full url to sdk api examples
2 parents 0f64b37 + 9bf7e91 commit 33dada7

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/reference/replicated-sdk-apis.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ For information about how to develop against the Replicated SDK API with mock da
1414

1515
List details about an application instance, including the app name, location of the Helm chart in the Replicated OCI registry, and details about the current application release that the instance is running.
1616

17-
```
18-
/api/v1/app/info
17+
```bash
18+
GET http://replicated:3000/api/v1/app/info
1919
```
2020

2121
Response:
@@ -48,8 +48,8 @@ Response:
4848

4949
List details about an application status, including the list of individual resource states and the overall application state.
5050

51-
```
52-
/api/v1/app/status
51+
```bash
52+
GET http://replicated:3000/api/v1/app/status
5353
```
5454

5555
Response:
@@ -77,8 +77,8 @@ Response:
7777

7878
List details about the releases that are available to an application instance for upgrade, including the version label, created timestamp, and release notes.
7979

80-
```
81-
/api/v1/app/updates
80+
```bash
81+
GET http://replicated:3000/api/v1/app/updates
8282
```
8383

8484
Response:
@@ -97,8 +97,8 @@ Response:
9797

9898
List details about the releases that an application instance has installed previously.
9999

100-
```
101-
/api/v1/app/history
100+
```bash
101+
GET http://replicated:3000/api/v1/app/history
102102
```
103103

104104
Response:
@@ -190,8 +190,8 @@ Response: Status `200` OK
190190

191191
List details about the license that was used to install, including the license ID, type, the customer name, and the channel the customer is assigned.
192192

193-
```
194-
/api/v1/license/info
193+
```bash
194+
GET http://replicated:3000/api/v1/license/info
195195
```
196196

197197
Response:
@@ -234,8 +234,8 @@ Response:
234234

235235
List details about all the fields in the license that was used to install, including the field names, descriptions, values, and signatures.
236236

237-
```
238-
/api/v1/license/fields
237+
```bash
238+
GET http://replicated:3000/api/v1/license/fields
239239
```
240240

241241
Response:
@@ -268,13 +268,13 @@ Response:
268268

269269
List details about one of the fields in the license that was used to install, including the field name, description, value, and signature.
270270

271-
```
272-
/api/v1/license/fields/\{field_name\}
271+
```bash
272+
GET http://replicated:3000/api/v1/license/fields/\{field_name\}
273273
```
274274

275275
Example request:
276276

277-
```
277+
```bash
278278
curl replicated:3000/api/v1/license/fields/expires_at
279279
```
280280

@@ -378,7 +378,7 @@ Get mock data that is used when Development Mode is enabled.
378378

379379
Programmatically set mock data that is used when Development Mode is enabled. The payload will overwrite the existing mock data. Any data that is not included in the payload will be removed. For example, to remove release data, simply include empty arrays:
380380

381-
```
381+
```bash
382382
POST http://replicated:3000/api/v1/integration/mock-data
383383
```
384384

0 commit comments

Comments
 (0)