Download Log - Download Log

Service:

Audit

API Version:

7.1-preview.1

Downloads audit log entries.

GET https://auditservice.dev.azure.com/{organization}/_apis/audit/downloadlog?format={format}&api-version=7.1-preview.1

With optional parameters:

GET https://auditservice.dev.azure.com/{organization}/_apis/audit/downloadlog?format={format}&startTime={startTime}&endTime={endTime}&api-version=7.1-preview.1

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
api-version	query	True	string	Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.
format	query	True	string	File format for download. Can be "json" or "csv".
endTime	query		string date-time	End time of download window. Optional
startTime	query		string date-time	Start time of download window. Optional

Responses

Name	Type	Description
200 OK	string	successful operation Media Types: "application/octet-stream"

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Description
vso.auditlog	Grants the ability to read the auditing log and audit streams to users

Examples

Download log as JSON

Sample request

HTTP

GET https://auditservice.dev.azure.com/{organization}/_apis/audit/downloadlog?format=json&startTime=2019-03-04T14:05:59.928Z&endTime=2019-03-05T14:05:59.928Z&api-version=7.1-preview.1

Sample response

Status code:

200