Share via

Image - Get Url

  • Reference
Service:
Azure Sphere Public API
API Version:
v2

Gets the URL where the specified Image can be downloaded.

GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/images/{imageId}

URI Parameters

Name In Required Type Description
imageId
 path True

string

uuid

The Image ID.
tenantId
 path True

string

uuid

The Azure Sphere tenant ID.

Responses

Name Type Description
200 OK

ImageDownloadInfo

Success.

Examples

Get the URL of an image's download site

Sample request

GET https://prod.core.sphere.azure.net/v2/tenants/768c2cd6-1bf0-4521-9f53-084a331d81cb/images/985453bb-eb5c-4ff2-8e06-aef4786ac445

Sample response

Status code:
200 
{
  "IsSuccess": true,
  "Uri": "https://prodptimg.blob.core.windows.net/768c2cd6-1bf0-4521-9f53-084a331d81cb/images/985453bb-eb5c-4ff2-8e06-aef4786ac445?remaining-part-of-URL",
  "UriMessage": null
}

Definitions

ImageDownloadInfo

Name Type Description
IsSuccess

boolean

Gets or sets a value indicating whether the request to get Image URI is successful.
Uri

string

Gets or sets the SAS image URI.
UriMessage

string

Gets or sets the image URI message if the request to get URI fails