---
title: "PUT /scenes/satellite/ingest-data/{jobId}"
method: PUT
path: "/scenes/satellite/ingest-data/{jobId}"
tags: ["Scenes"]
---

# PUT /scenes/satellite/ingest-data/{jobId}

`PUT /scenes/satellite/ingest-data/{jobId}`

## Request

- Base URL: `{endpoint}`
- URL: `{endpoint}/scenes/satellite/ingest-data/{jobId}`
- Auth: API key in header `Authorization`

Create a satellite data ingestion job.

## Path parameters

- `jobId` string, required

## Query parameters

- `api-version` string, required

## Request body

- SatelliteDataIngestionJob: Schema of satellite data ingestion job.
  - `credentials` OAuthClientCredentials: AuthCredentials abstract base class for Auth Purpose.
    - `kind` 'OAuthClientCredentials' | 'ApiKeyAuthCredentials', required: Enum for different types of AuthCredentials supported.
    - `clientId` string, required: ClientId associated with the provider.
    - `clientSecret` KeyVaultProperties, required: Properties of the key vault.
      - `keyVaultUri` string, required: Uri of the key vault.
      - `keyName` string, required: Name of Key Vault key.
      - `keyVersion` string, required: Version of Key Vault key.
  - `partyId` string, required: Party Id.
  - `associatedResource` GeoResource, required: Schema for storing resource type and resource id.
    - `type` 'Field' | 'SeasonalField' | 'Zone' | 'Prescription' | 'PlantTissueAnalysis' | 'PlantingData' | 'ApplicationData' | 'HarvestData' | 'TillageData': Resource Type.
    - `id` string: Resource Id.
  - `startDateTime` string, date-time: Start Date.
  - `endDateTime` string, date-time: End Date.
  - `provider` 'SentinelHub': Provider of satellite data. Available Value: SentinelHub.
  - `collection` string, required: Collection of satellite data. Available Value: sentinel-2-l2a, sentinel-2-l1c.
  - `data` SatelliteData: Data Model for SatelliteIngestionJobRequest.
    - `imageNames` string[]: List of ImageNames.
    - `imageFormats` string[]: List of ImageFormats. Available value: TIF.
    - `imageResolutions` number[]: List of ImageResolutions in meters. Available values: 10, 20, 60.
  - `itemId` string: Item Id used to get scenes from sentinel hub.
  - `id` string: Unique job id.
  - `status` string: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.
  - `durationInSeconds` number, double: Duration of the job in seconds.
  - `message` string: Status message to capture more details of the job.
  - `errorCode` string: Error Code when job failed.
  - `createdDateTime` string, date-time: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  - `lastActionDateTime` string, date-time: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  - `startTime` string, date-time: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  - `endTime` string, date-time: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  - `name` string: Name to identify resource.
  - `description` string: Textual description of the resource.
  - `createdBy` string: Created by user/tenant id.
  - `modifiedBy` string: Modified by user/tenant id.
  - `properties` object: A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.

## Response `202`

Accepted

- SatelliteDataIngestionJob: Schema of satellite data ingestion job.
  - `credentials` OAuthClientCredentials: AuthCredentials abstract base class for Auth Purpose.
    - `kind` 'OAuthClientCredentials' | 'ApiKeyAuthCredentials', required: Enum for different types of AuthCredentials supported.
    - `clientId` string, required: ClientId associated with the provider.
    - `clientSecret` KeyVaultProperties, required: Properties of the key vault.
      - `keyVaultUri` string, required: Uri of the key vault.
      - `keyName` string, required: Name of Key Vault key.
      - `keyVersion` string, required: Version of Key Vault key.
  - `partyId` string, required: Party Id.
  - `associatedResource` GeoResource, required: Schema for storing resource type and resource id.
    - `type` 'Field' | 'SeasonalField' | 'Zone' | 'Prescription' | 'PlantTissueAnalysis' | 'PlantingData' | 'ApplicationData' | 'HarvestData' | 'TillageData': Resource Type.
    - `id` string: Resource Id.
  - `startDateTime` string, date-time: Start Date.
  - `endDateTime` string, date-time: End Date.
  - `provider` 'SentinelHub': Provider of satellite data. Available Value: SentinelHub.
  - `collection` string, required: Collection of satellite data. Available Value: sentinel-2-l2a, sentinel-2-l1c.
  - `data` SatelliteData: Data Model for SatelliteIngestionJobRequest.
    - `imageNames` string[]: List of ImageNames.
    - `imageFormats` string[]: List of ImageFormats. Available value: TIF.
    - `imageResolutions` number[]: List of ImageResolutions in meters. Available values: 10, 20, 60.
  - `itemId` string: Item Id used to get scenes from sentinel hub.
  - `id` string: Unique job id.
  - `status` string: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.
  - `durationInSeconds` number, double: Duration of the job in seconds.
  - `message` string: Status message to capture more details of the job.
  - `errorCode` string: Error Code when job failed.
  - `createdDateTime` string, date-time: Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  - `lastActionDateTime` string, date-time: Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  - `startTime` string, date-time: Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  - `endTime` string, date-time: Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  - `name` string: Name to identify resource.
  - `description` string: Textual description of the resource.
  - `createdBy` string: Created by user/tenant id.
  - `modifiedBy` string: Modified by user/tenant id.
  - `properties` object: A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/azure/apis/agrifood-agfoodplatform.md) - [All operations](https://skmtc.dev/azure/apis/agrifood-agfoodplatform/llms.txt) - [OpenAPI document](https://skmtc.dev/azure/apis/agrifood-agfoodplatform/revisions/33cf1de6e0c4?raw)
