Visualstudio

VSOnline

Public APIs for managing VS Codespaces

Developer tools#openapi#developer-tools#collaboration

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Public APIs for managing VS Codespaces

Endpoints 152

AgentTelemetry

  • POSTPOST /api/v1/AgentTelemetry/api/v1/AgentTelemetry
  • POSTPOST /api/v1/AgentTelemetry/standalone/api/v1/AgentTelemetry/standalone

Agents

  • GETGET /api/v1/Agents/{family}/api/v1/Agents/:family

Environments

  • GETGET /api/v1/Environments/api/v1/Environments?name=string&planId=string&deleted=false
  • POSTPOST /api/v1/Environments/api/v1/Environments?access=true
  • GETGetEnvironmentRoute/api/v1/Environments/:environmentId?connect=true&pfConnect=true&deleted=false
  • DELETEDELETE /api/v1/Environments/{environmentId}/api/v1/Environments/:environmentId
  • PATCHPATCH /api/v1/Environments/{environmentId}/api/v1/Environments/:environmentId
  • POSTUpdateEnvironmentRoute/api/v1/Environments/:environmentId/_callback
  • GETGET /api/v1/Environments/{environmentId}/archive/api/v1/Environments/:environmentId/archive
  • POSTPOST /api/v1/Environments/{environmentId}/archive/api/v1/Environments/:environmentId/archive
  • POSTPOST /api/v1/Environments/{environmentId}/export/api/v1/Environments/:environmentId/export
  • PATCHPATCH /api/v1/Environments/{environmentId}/folder/api/v1/Environments/:environmentId/folder
  • GETGET /api/v1/Environments/{environmentId}/heartbeattoken/api/v1/Environments/:environmentId/heartbeattoken
  • POSTPOST /api/v1/Environments/{environmentId}/notify/api/v1/Environments/:environmentId/notify
  • PUTPUT /api/v1/Environments/{environmentId}/ports/{port}/api/v1/Environments/:environmentId/ports/:port
  • DELETEDELETE /api/v1/Environments/{environmentId}/ports/{port}/api/v1/Environments/:environmentId/ports/:port
  • PATCHPATCH /api/v1/Environments/{environmentId}/restore/api/v1/Environments/:environmentId/restore
  • PUTPUT /api/v1/Environments/{environmentId}/secrets/api/v1/Environments/:environmentId/secrets
  • POSTPOST /api/v1/Environments/{environmentId}/shutdown/api/v1/Environments/:environmentId/shutdown
  • POSTPOST /api/v1/Environments/{environmentId}/start/api/v1/Environments/:environmentId/start?access=true
  • GETGET /api/v1/Environments/{environmentId}/state/api/v1/Environments/:environmentId/state
  • GETGET /api/v1/Environments/{environmentId}/updates/api/v1/Environments/:environmentId/updates
  • GETGET /api/v1/GenevaActions/Environments/{environmentId}/api/v1/GenevaActions/Environments/:environmentId
  • DELETEDELETE /api/v1/GenevaActions/Environments/{environmentId}/api/v1/GenevaActions/Environments/:environmentId?deletionType=string
  • PUTPUT /api/v1/GenevaActions/Environments/{environmentId}/archive/api/v1/GenevaActions/Environments/:environmentId/archive
  • GETGET /api/v1/GenevaActions/Environments/{environmentId}/archived_storage_sas/{targetBlob}/api/v1/GenevaActions/Environments/:environmentId/archived_storage_sas/:targetBlob
  • PUTPUT /api/v1/GenevaActions/Environments/{environmentId}/shutdown/api/v1/GenevaActions/Environments/:environmentId/shutdown
  • POSTPOST /api/v1/GenevaActions/Environments/{environmentId}/upload/running/vm/logs/api/v1/GenevaActions/Environments/:environmentId/upload/running/vm/logs

Billing

  • POSTPOST /api/v1/GenevaActions/Billing/resend/api/v1/GenevaActions/Billing/resend
  • GETGET /api/v1/GenevaActions/Billing/{environmentId}/api/v1/GenevaActions/Billing/:environmentId?startTime=string&endTime=string
  • GETGET /api/v1/GenevaActions/Billing/{environmentId}/state-changes/api/v1/GenevaActions/Billing/:environmentId/state-changes
  • POSTPOST /api/v1/GenevaActions/Billing/{environmentId}/state-changes/api/v1/GenevaActions/Billing/:environmentId/state-changes

Configuration

  • POSTPOST /api/v1/GenevaActions/Configuration/{target}/api/v1/GenevaActions/Configuration/:target
  • GETGET /api/v1/GenevaActions/Configuration/{target}/{key}/api/v1/GenevaActions/Configuration/:target/:key
  • DELETEDELETE /api/v1/GenevaActions/Configuration/{target}/{key}/api/v1/GenevaActions/Configuration/:target/:key

Pools

  • POSTPOST /api/v1/GenevaActions/Pools/change-resource-deletion-setting/api/v1/GenevaActions/Pools/change-resource-deletion-setting
  • POSTPOST /api/v1/GenevaActions/Pools/{poolCode}/rotate-pool/api/v1/GenevaActions/Pools/:poolCode/rotate-pool
  • POSTPOST /api/v1/GenevaActions/Pools/{target}/api/v1/GenevaActions/Pools/:target
  • GETGET /api/v1/pools/default/api/v1/pools/default?skuName=string

Prebuilds

  • POSTPOST /api/v1/GenevaActions/Prebuilds/pools/createorupdatesettings/api/v1/GenevaActions/Prebuilds/pools/createorupdatesettings
  • POSTPOST /api/v1/GenevaActions/Prebuilds/pools/delete/api/v1/GenevaActions/Prebuilds/pools/delete
  • PUTPUT /api/v1/Prebuilds/pools/{poolId}/instances/api/v1/Prebuilds/pools/:poolId/instances
  • POSTPOST /api/v1/Prebuilds/pools/{poolId}/instances/api/v1/Prebuilds/pools/:poolId/instances
  • GETGetTemplateInfoRoute/api/v1/Prebuilds/template/:environmentId
  • GETGetPrebuildReadinessRoute/api/v1/Prebuilds/templates/repo/:repoId/branch/:branchName/hash/:prebuildHash/location/:location/skus?storageType=0 (V1)

Privacy

  • POSTPOST /api/v1/GenevaActions/Privacy/refresh-profile-telemetry-properties/api/v1/GenevaActions/Privacy/refresh-profile-telemetry-properties

Resources

  • POSTPOST /api/v1/GenevaActions/Resources/{resourceId}/under-investigation/api/v1/GenevaActions/Resources/:resourceId/under-investigation

VnetPoolDefinitions

  • POSTPOST /api/v1/GenevaActions/VnetPoolDefinitions/api/v1/GenevaActions/VnetPoolDefinitions
  • DELETEDELETE /api/v1/GenevaActions/VnetPoolDefinitions/api/v1/GenevaActions/VnetPoolDefinitions

HeartBeat

  • POSTPOST /api/v1/HeartBeat/api/v1/HeartBeat

Locations

  • GETGET /api/v1/Locations/api/v1/Locations
  • GETGET /api/v1/Locations/{location}/api/v1/Locations/:location?planId=string

Sas

  • GETGET /api/v1/Sas/api/v1/Sas

Secrets

  • GETGET /api/v1/Secrets/api/v1/Secrets?planId=string
  • POSTPOST /api/v1/Secrets/api/v1/Secrets?planId=string
  • PUTPUT /api/v1/Secrets/{secretId}/api/v1/Secrets/:secretId?planId=string
  • DELETEDELETE /api/v1/Secrets/{secretId}/api/v1/Secrets/:secretId?planId=string&scope=1 (Plan)

Tenant

  • GETGET /api/v1/Tenant/{tenantId}/api/v1/Tenant/:tenantId
  • PUTPUT /api/v1/Tenant/{tenantId}/api/v1/Tenant/:tenantId
  • DELETEDELETE /api/v1/Tenant/{tenantId}/api/v1/Tenant/:tenantId

Tokens

  • POSTPOST /api/v1/Tokens/plans/{planName}/deleteAllCodespaces/api/v1/Tokens/plans/:planName/deleteAllCodespaces?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/Tokens/plans/{planName}/readAllCodespaces/api/v1/Tokens/plans/:planName/readAllCodespaces?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/Tokens/plans/{planName}/writeCodespaces/api/v1/Tokens/plans/:planName/writeCodespaces?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/Tokens/plans/{planName}/writeDelegates/api/v1/Tokens/plans/:planName/writeDelegates
  • PUTPUT /api/v1/Tokens/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/{providerNamespace}/plans/{resourceName}/api/v1/Tokens/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/:providerNamespace/plans/:resourceName
  • POSTPOST /api/v1/Tokens/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/{providerNamespace}/plans/{resourceName}/deleteAllCodespaces/api/v1/Tokens/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/:providerNamespace/plans/:resourceName/deleteAllCodespaces?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/Tokens/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/{providerNamespace}/plans/{resourceName}/deleteAllEnvironments/api/v1/Tokens/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/:providerNamespace/plans/:resourceName/deleteAllEnvironments?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/Tokens/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/{providerNamespace}/plans/{resourceName}/readAllCodespaces/api/v1/Tokens/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/:providerNamespace/plans/:resourceName/readAllCodespaces?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/Tokens/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/{providerNamespace}/plans/{resourceName}/readAllEnvironments/api/v1/Tokens/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/:providerNamespace/plans/:resourceName/readAllEnvironments?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/Tokens/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/{providerNamespace}/plans/{resourceName}/writeCodespaces/api/v1/Tokens/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/:providerNamespace/plans/:resourceName/writeCodespaces?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/Tokens/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/{providerNamespace}/plans/{resourceName}/writeDelegates/api/v1/Tokens/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/:providerNamespace/plans/:resourceName/writeDelegates
  • POSTPOST /api/v1/Tokens/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/{providerNamespace}/plans/{resourceName}/writeEnvironments/api/v1/Tokens/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/:providerNamespace/plans/:resourceName/writeEnvironments?expiration=2024-01-01T00:00:00Z

Tunnel

  • GETGET /api/v1/Tunnel/{environmentId}/portInfo/api/v1/Tunnel/:environmentId/portInfo?portNumber=0

UserSubscriptions

  • POSTPOST /api/v1/UserSubscriptions/api/v1/UserSubscriptions?email=string
  • DELETEDELETE /api/v1/UserSubscriptions/api/v1/UserSubscriptions?email=string

NetworkSettings

  • PUTPUT /api/v1/subscriptions/{subscriptionId}/providers/GitHub.Network/{resourceType}/SubscriptionLifeCycleNotification/api/v1/subscriptions/:subscriptionId/providers/GitHub.Network/:resourceType/SubscriptionLifeCycleNotification
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/providers/GitHub.Network/{resourceType}/resourceReadBegin/api/v1/subscriptions/:subscriptionId/providers/GitHub.Network/:resourceType/resourceReadBegin
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/GitHub.Network/{resourceType}/resourceReadBegin/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/GitHub.Network/:resourceType/resourceReadBegin
  • PUTPUT /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/GitHub.Network/{resourceType}/{resourceName}/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/GitHub.Network/:resourceType/:resourceName
  • DELETEDELETE /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/GitHub.Network/{resourceType}/{resourceName}/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/GitHub.Network/:resourceType/:resourceName
  • PATCHPATCH /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/GitHub.Network/{resourceType}/{resourceName}/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/GitHub.Network/:resourceType/:resourceName
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/GitHub.Network/{resourceType}/{resourceName}/resourceCreationCompleted/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/GitHub.Network/:resourceType/:resourceName/resourceCreationCompleted
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/GitHub.Network/{resourceType}/{resourceName}/resourceCreationValidate/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/GitHub.Network/:resourceType/:resourceName/resourceCreationValidate
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/GitHub.Network/{resourceType}/{resourceName}/resourceDeletionCompleted/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/GitHub.Network/:resourceType/:resourceName/resourceDeletionCompleted
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/GitHub.Network/{resourceType}/{resourceName}/resourceDeletionValidate/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/GitHub.Network/:resourceType/:resourceName/resourceDeletionValidate
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/GitHub.Network/{resourceType}/{resourceName}/resourcePatchCompleted/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/GitHub.Network/:resourceType/:resourceName/resourcePatchCompleted
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/GitHub.Network/{resourceType}/{resourceName}/resourcePatchValidate/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/GitHub.Network/:resourceType/:resourceName/resourcePatchValidate
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/GitHub.Network/{resourceType}/{resourceName}/resourceReadBegin/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/GitHub.Network/:resourceType/:resourceName/resourceReadBegin

Plans

  • PUTPUT /api/v1/subscriptions/{subscriptionId}/providers/Microsoft.Codespaces/plans/SubscriptionLifeCycleNotification/api/v1/subscriptions/:subscriptionId/providers/Microsoft.Codespaces/plans/SubscriptionLifeCycleNotification
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/providers/Microsoft.Codespaces/plans/resourceReadBegin/api/v1/subscriptions/:subscriptionId/providers/Microsoft.Codespaces/plans/resourceReadBegin
  • PUTPUT /api/v1/subscriptions/{subscriptionId}/providers/Microsoft.VSOnline/plans/SubscriptionLifeCycleNotification/api/v1/subscriptions/:subscriptionId/providers/Microsoft.VSOnline/plans/SubscriptionLifeCycleNotification
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/providers/Microsoft.VSOnline/plans/resourceReadBegin/api/v1/subscriptions/:subscriptionId/providers/Microsoft.VSOnline/plans/resourceReadBegin
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Codespaces/plans/resourceReadBegin/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.Codespaces/plans/resourceReadBegin
  • PUTPUT /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Codespaces/plans/{resourceName}/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.Codespaces/plans/:resourceName
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Codespaces/plans/{resourceName}/deleteAllCodespaces/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.Codespaces/plans/:resourceName/deleteAllCodespaces?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Codespaces/plans/{resourceName}/deleteAllEnvironments/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.Codespaces/plans/:resourceName/deleteAllEnvironments?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Codespaces/plans/{resourceName}/readAllCodespaces/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.Codespaces/plans/:resourceName/readAllCodespaces?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Codespaces/plans/{resourceName}/readAllEnvironments/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.Codespaces/plans/:resourceName/readAllEnvironments?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Codespaces/plans/{resourceName}/readDelegates/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.Codespaces/plans/:resourceName/readDelegates
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Codespaces/plans/{resourceName}/resourceCreationCompleted/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.Codespaces/plans/:resourceName/resourceCreationCompleted
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Codespaces/plans/{resourceName}/resourceCreationValidate/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.Codespaces/plans/:resourceName/resourceCreationValidate
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Codespaces/plans/{resourceName}/resourceDeletionValidate/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.Codespaces/plans/:resourceName/resourceDeletionValidate
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Codespaces/plans/{resourceName}/resourcePatchCompleted/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.Codespaces/plans/:resourceName/resourcePatchCompleted
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Codespaces/plans/{resourceName}/resourcePatchValidate/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.Codespaces/plans/:resourceName/resourcePatchValidate
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Codespaces/plans/{resourceName}/resourceReadBegin/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.Codespaces/plans/:resourceName/resourceReadBegin
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Codespaces/plans/{resourceName}/writeCodespaces/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.Codespaces/plans/:resourceName/writeCodespaces?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Codespaces/plans/{resourceName}/writeDelegates/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.Codespaces/plans/:resourceName/writeDelegates
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Codespaces/plans/{resourceName}/writeEnvironments/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.Codespaces/plans/:resourceName/writeEnvironments?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.VSOnline/plans/resourceReadBegin/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.VSOnline/plans/resourceReadBegin
  • PUTPUT /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.VSOnline/plans/{resourceName}/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.VSOnline/plans/:resourceName
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.VSOnline/plans/{resourceName}/deleteAllCodespaces/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.VSOnline/plans/:resourceName/deleteAllCodespaces?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.VSOnline/plans/{resourceName}/deleteAllEnvironments/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.VSOnline/plans/:resourceName/deleteAllEnvironments?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.VSOnline/plans/{resourceName}/readAllCodespaces/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.VSOnline/plans/:resourceName/readAllCodespaces?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.VSOnline/plans/{resourceName}/readAllEnvironments/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.VSOnline/plans/:resourceName/readAllEnvironments?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.VSOnline/plans/{resourceName}/readDelegates/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.VSOnline/plans/:resourceName/readDelegates
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.VSOnline/plans/{resourceName}/resourceCreationCompleted/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.VSOnline/plans/:resourceName/resourceCreationCompleted
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.VSOnline/plans/{resourceName}/resourceCreationValidate/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.VSOnline/plans/:resourceName/resourceCreationValidate
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.VSOnline/plans/{resourceName}/resourceDeletionValidate/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.VSOnline/plans/:resourceName/resourceDeletionValidate
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.VSOnline/plans/{resourceName}/resourcePatchCompleted/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.VSOnline/plans/:resourceName/resourcePatchCompleted
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.VSOnline/plans/{resourceName}/resourcePatchValidate/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.VSOnline/plans/:resourceName/resourcePatchValidate
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.VSOnline/plans/{resourceName}/resourceReadBegin/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.VSOnline/plans/:resourceName/resourceReadBegin
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.VSOnline/plans/{resourceName}/writeCodespaces/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.VSOnline/plans/:resourceName/writeCodespaces?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.VSOnline/plans/{resourceName}/writeDelegates/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.VSOnline/plans/:resourceName/writeDelegates
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.VSOnline/plans/{resourceName}/writeEnvironments/api/v1/subscriptions/:subscriptionId/resourceGroups/:resourceGroup/providers/Microsoft.VSOnline/plans/:resourceName/writeEnvironments?expiration=2024-01-01T00:00:00Z
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/{resourceGroup}/providers/Microsoft.Codespaces/plans/{resourceName}/deleteDelegates/api/v1/subscriptions/:subscriptionId/:resourceGroup/providers/Microsoft.Codespaces/plans/:resourceName/deleteDelegates
  • POSTPOST /api/v1/subscriptions/{subscriptionId}/{resourceGroup}/providers/Microsoft.VSOnline/plans/{resourceName}/deleteDelegates/api/v1/subscriptions/:subscriptionId/:resourceGroup/providers/Microsoft.VSOnline/plans/:resourceName/deleteDelegates

Pool

  • GETGET /api/v1/tenant/{tenantId}/Pool/{poolName}/api/v1/tenant/:tenantId/Pool/:poolName
  • PUTPUT /api/v1/tenant/{tenantId}/Pool/{poolName}/api/v1/tenant/:tenantId/Pool/:poolName
  • DELETEDELETE /api/v1/tenant/{tenantId}/Pool/{poolName}/api/v1/tenant/:tenantId/Pool/:poolName
  • PATCHPATCH /api/v1/tenant/{tenantId}/Pool/{poolName}/api/v1/tenant/:tenantId/Pool/:poolName

PoolGroup

  • GETGET /api/v1/tenant/{tenantId}/PoolGroup/{poolGroupName}/api/v1/tenant/:tenantId/PoolGroup/:poolGroupName
  • PUTPUT /api/v1/tenant/{tenantId}/PoolGroup/{poolGroupName}/api/v1/tenant/:tenantId/PoolGroup/:poolGroupName
  • DELETEDELETE /api/v1/tenant/{tenantId}/PoolGroup/{poolGroupName}/api/v1/tenant/:tenantId/PoolGroup/:poolGroupName
  • PATCHPATCH /api/v1/tenant/{tenantId}/PoolGroup/{poolGroupName}/api/v1/tenant/:tenantId/PoolGroup/:poolGroupName

Vm

  • GETGET /api/v1/tenant/{tenantId}/pool/{poolName}/Vm/api/v1/tenant/:tenantId/pool/:poolName/Vm
  • GETGET /api/v1/tenant/{tenantId}/pool/{poolName}/Vm/{vmName}/api/v1/tenant/:tenantId/pool/:poolName/Vm/:vmName
  • PUTPUT /api/v1/tenant/{tenantId}/pool/{poolName}/Vm/{vmName}/api/v1/tenant/:tenantId/pool/:poolName/Vm/:vmName
  • DELETEDELETE /api/v1/tenant/{tenantId}/pool/{poolName}/Vm/{vmName}/api/v1/tenant/:tenantId/pool/:poolName/Vm/:vmName
  • POSTPOST /api/v1/tenant/{tenantId}/pool/{poolName}/Vm/{vmName}/start/api/v1/tenant/:tenantId/pool/:poolName/Vm/:vmName/start
  • POSTPOST /api/v1/tenant/{tenantId}/pool/{poolName}/Vm/{vmName}/stop/api/v1/tenant/:tenantId/pool/:poolName/Vm/:vmName/stop

PrebuildsV

  • POSTPOST /api/v2/prebuilds/delete/api/v2/prebuilds/delete
  • DELETEDELETE /api/v2/prebuilds/repository/{repoId}/branch/{branchName}/api/v2/prebuilds/repository/:repoId/branch/:branchName
  • POSTPOST /api/v2/prebuilds/templates/api/v2/prebuilds/templates
  • GETGetPrebuildReadinessSkusRoute/api/v2/prebuilds/templates/skus/repo/:repoId/branch/:branchName/hash/:prebuildHash/location/:location/devcontainerpath/:devContainerPath?storageType=0 (V1)&fastPathEnabled=true
  • POSTPOST /api/v2/prebuilds/templates/updatemaxversions/api/v2/prebuilds/templates/updatemaxversions
  • POSTPOST /api/v2/prebuilds/templates/{templateId}/updatestatus/api/v2/prebuilds/templates/:templateId/updatestatus

Health

  • GETGET /health/health

Netmon

  • GETGET /internal/Netmon/correlation/internal/Netmon/correlation?macAddress=string

Authentication

  • GETGET /tunnelauth/tunnelauth?id=string&cluster=string&name=string&port=0&pb=string
  • POSTPOST /tunnelauth/tunnelauth?op=string&id=string&cluster=string&name=string&port=0

Warmup

  • GETGET /warmup/warmup

API details

Base URL
https://online.visualstudio.com
Authentication
A bearer token in the Authorization header
Operations
152 operations on 126 pathsPOST 86GET 30PUT 17DELETE 13PATCH 6
Main resources
Plans 38Environments 26NetworkSettings 13Tokens 12Prebuilds 6PrebuildsV 6Vm 6Billing 4Pool 4PoolGroup 4
Response formats
application/json text/json text/plain
Description format
OpenAPI 3.0.1, API version v1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the VSOnline in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the VSOnline collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “POST /api/v1/AgentTelemetry” (POST /api/v1/AgentTelemetry), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the VSOnline?

Public APIs for managing VS Codespaces It is listed under Developer tools and has 152 endpoints.

Who publishes the VSOnline?

It is listed from Visualstudio's public API description (an OpenAPI document), not published by Visualstudio on Swastik Codes. Anyone who controls visualstudio.com can claim the profile by adding a DNS TXT record.

What is the base URL of the VSOnline?

Requests go to https://online.visualstudio.com. Endpoint paths are added to this base URL.

How do I authenticate with the VSOnline?

With A bearer token in the Authorization header.

How many endpoints does the VSOnline have?

152 operations on 126 paths (86 POST, 30 GET, 17 PUT, 13 DELETE, 6 PATCH). The largest groups are Plans, Environments, NetworkSettings, Tokens.

Is forking the VSOnline free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.