Skip to content

Gets a migration job

GET/migrations/{migrationJobId}

Endpoint API · Migrations

Get a single migration job.

Required permissionendpoint-migration:read

Parameters

Name In Type Required Description
X-Tenant-ID header string (uuid) Yes Tenant ID.
migrationJobId path string (uuid) Yes Migration job ID.

Request samples

curl -X GET "https://api-<data-region>.central.sophos.com/endpoint/v1/migrations/<migrationJobId>" -H "Authorization: Bearer <access-token>" -H "X-Tenant-ID: <tenant-id>"


import requests

response = requests.get(
    "https://api-<data-region>.central.sophos.com/endpoint/v1/migrations/<migrationJobId>",
    headers={
        "Authorization": "Bearer <access-token>",
        "X-Tenant-ID": "<tenant-id>",
    },
)
print(response.json())


$headers = @{
    "Authorization" = "Bearer <access-token>"
    "X-Tenant-ID" = "<tenant-id>"
}
Invoke-RestMethod -Method GET -Uri "https://api-<data-region>.central.sophos.com/endpoint/v1/migrations/<migrationJobId>" -Headers $headers


package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, err := http.NewRequest("GET", "https://api-<data-region>.central.sophos.com/endpoint/v1/migrations/<migrationJobId>", nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer <access-token>")
    req.Header.Set("X-Tenant-ID", "<tenant-id>")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}


const response = await fetch("https://api-<data-region>.central.sophos.com/endpoint/v1/migrations/<migrationJobId>", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <access-token>",
    "X-Tenant-ID": "<tenant-id>",
  },
});
const data = await response.json();
console.log(data);

Responses

200 — Migration job.

Response fields

idstring (uuid)required
Migration job ID.
tokenstring
Job token.
modestringrequired
Whether the tenant is sending or receiving endpoints.
Must be one of: sending, receiving.
createdAtstring (date-time)required
When the job was created.
createdByobject
Show child attributesHide child attributes
idstringrequired
Principal Email or clientId.
typestring (enum)required
Principal type.
Must be one of: user, service, system.
namestring
User Principal name.
accountTypestring
Account type.
Must be one of: partner, tenant, organization.
accountIdstring (uuid)
Account ID.
expiresAtstring (date-time)required
When the migration job expires.

Errors

Status Meaning
400 Bad Request.
404 Migration job not found.
500 Unexpected error.

All error responses share the same shape — see the error response object.

Response examples

200

{
  "id": "c83bc7f6-7c93-4aa4-ac73-006bd5a5884a",
  "token": "eyJmb28iOiJ434833989debe92389we9e8debe902392388ede982372309099de9999a0a7732736611222fff2f1f212fffef3f592983iYXIifQo=",
  "mode": "receiving",
  "createdAt": "2021-04-22T15:32:28.482Z",
  "expiresAt": "2021-04-29T15:32:28.482Z"
}

See the guide for a narrative walkthrough of this API.