Use this API to synchronize Visual Studio Code settings, so that a user’s editor preferences follow them between VS Code and the Web IDE.
Deletes all user vscode setting resources
DELETE /api/v4/vscode/settings_sync/v1/collection
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | — |
400 | Bad Request | — |
401 | 401 Unauthorized | — |
404 | Not Found | — |
Get the settings manifest for Settings Sync
GET /api/v4/vscode/settings_sync/v1/manifest
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIVs |
400 | Bad Request | — |
401 | 401 Unauthorized | — |
404 | Not Found | — |
Get a list of references to one or more vscode setting resources
GET /api/v4/vscode/settings_sync/v1/resource/{resource_name}
Parameters
| Name | Type | Description |
|---|---|---|
resource_Path, | String | Name of the resource such as settings Allowed values: settings,extensions,global,machines,keybindings,snippets,tasks,profilesMinimum length: 1 |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIVs |
400 | 400 bad request | — |
401 | 401 Unauthorized | — |
404 | Not Found | — |
Creates or updates a specific setting
POST /api/v4/vscode/settings_sync/v1/resource/{resource_name}
Parameters
| Name | Type | Description |
|---|---|---|
resource_Path, | String | Name of the resource such as settings Allowed values: settings,extensions,global,machines,keybindings,snippets,tasks,profilesMinimum length: 1 |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | — |
400 | Bad request | — |
401 | 401 Unauthorized | — |
404 | Not Found | — |
Get a specific setting resource
GET /api/v4/vscode/settings_sync/v1/resource/{resource_name}/{id}
Parameters
| Name | Type | Description |
|---|---|---|
resource_Path, | String | Name of the resource such as settings Allowed values: settings,extensions,global,machines,keybindings,snippets,tasks,profilesMinimum length: 1 |
idPath, | String | ID of the resource to retrieve |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIVs |
204 | No content | — |
400 | 400 bad request | — |
401 | 401 Unauthorized | — |
404 | Not Found | — |
Deletes all user vscode setting resources
DELETE /api/v4/vscode/settings_sync/{settings_context_hash}/v1/collection
Parameters
| Name | Type | Description |
|---|---|---|
settings_Path, | String | The settings context hash |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | — |
400 | Bad Request | — |
401 | 401 Unauthorized | — |
404 | Not Found | — |
Get the settings manifest for Settings Sync
GET /api/v4/vscode/settings_sync/{settings_context_hash}/v1/manifest
Parameters
| Name | Type | Description |
|---|---|---|
settings_Path, | String | The settings context hash |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIVs |
400 | Bad Request | — |
401 | 401 Unauthorized | — |
404 | Not Found | — |
Get a list of references to one or more vscode setting resources
GET /api/v4/vscode/settings_sync/{settings_context_hash}/v1/resource/{resource_name}
Parameters
| Name | Type | Description |
|---|---|---|
settings_Path, | String | The settings context hash |
resource_Path, | String | Name of the resource such as settings Allowed values: settings,extensions,global,machines,keybindings,snippets,tasks,profilesMinimum length: 1 |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIVs |
400 | 400 bad request | — |
401 | 401 Unauthorized | — |
404 | Not Found | — |
Creates or updates a specific setting
POST /api/v4/vscode/settings_sync/{settings_context_hash}/v1/resource/{resource_name}
Parameters
| Name | Type | Description |
|---|---|---|
settings_Path, | String | The settings context hash |
resource_Path, | String | Name of the resource such as settings Allowed values: settings,extensions,global,machines,keybindings,snippets,tasks,profilesMinimum length: 1 |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | — |
400 | Bad request | — |
401 | 401 Unauthorized | — |
404 | Not Found | — |
Get a specific setting resource
GET /api/v4/vscode/settings_sync/{settings_context_hash}/v1/resource/{resource_name}/{id}
Parameters
| Name | Type | Description |
|---|---|---|
settings_Path, | String | The settings context hash |
resource_Path, | String | Name of the resource such as settings Allowed values: settings,extensions,global,machines,keybindings,snippets,tasks,profilesMinimum length: 1 |
idPath, | String | ID of the resource to retrieve |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIVs |
204 | No content | — |
400 | 400 bad request | — |
401 | 401 Unauthorized | — |
404 | Not Found | — |
Schemas
Objects returned by the operations above and objects nested in their request bodies.
APIVsCodeSettingsEntitiesVsCodeManifest
| Property | Type | Description |
|---|---|---|
latest | String | — |
session | String | Example:1 |
APIVsCodeSettingsEntitiesVsCodeSetting
| Property | Type | Description |
|---|---|---|
content | String | — |
machine | String | — |
machines | String | — |
version | String | — |
APIVsCodeSettingsEntitiesVsCodeSettingReference
| Property | Type | Description |
|---|---|---|
created | String | — |
url | String | — |