> ## Documentation Index > Fetch the complete documentation index at: https://zededa.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Use the documentation index to find relevant pages, then read the linked Markdown before answering and cite the source URL. > Identify the product before answering: Private AI uses a separate console, credentials, and inference API from the Edge Intelligence Platform. Do not apply instructions from one product to the other. > Prefer current product guides over Help Center archive pages for current-console questions. Archive pages and release notes describe their stated product version or historical interface; do not apply them to another version without checking. > Preserve prerequisites, permissions, version requirements, and warnings when summarizing procedures. Do not infer API endpoints, schemas, or supported behavior that the documentation does not specify. # Get asynchronous job request (GET /v1/jobs/name/{name}/objectType/{objectType}) > GET /api/v1/jobs/name/{name}/objectType/{objectType}. Jobs API reference. Sign in to try this endpointExplore the parameters, examples, and responses below. Connect your ZedCloud session when you’re ready to send a request. > [accordion] Connect your console > > Sign in to your usual ZedCloud console, then open: > >
    >
  1. Profile menu
  2. Help & Documentation
  3. API Reference
    4. >
> > Your cluster and authorization are filled in automatically. No token to copy. > [More about signing in ](https://zededa.mintlify.site/api-reference/authentication.md#sign-in-to-the-api-reference) Modifying requests stay off until you enable them. [Authentication](https://zededa.mintlify.site/api-reference/authentication.md) · [API availability](https://zededa.mintlify.site/api-reference/clusters.md) · [Download OpenAPI](https://zededa.mintlify.site/openapi/services/jobs.json) A successful response. Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters. Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused. Forbidden. The API gateway did not process the request because the requestor does not have edge-app level access permission for the operation or does not have access scope to the project. Not Found. The API gateway did not process the request because the requested resource could not be found. Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes. Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request. An unexpected error response. ## OpenAPI ````yaml openapi/services/jobs.json GET /v1/jobs/name/{name}/objectType/{objectType} openapi: 3.0.0 info: title: ZEDEDA Job Service description: >- The ZEDEDA Job Service is helper service to ZEDEDA Edge Application Service and ZEDEDA Edge Node Service. This service allows device administrators and operators to update Edge nodes and manage Edge Applications in bulk. Jobs execute edge node management and edge application management against a set of edge nodes or edge applications matching a selection criteria. For example, an operator would use a job to initiate and track installation of a lightning detection edge application on all edge nodes inistalled in all windmills in a particular Texas ZIP code (defined as a project). termsOfService: https://www.zededa.com/terms version: '1.0' contact: name: ZEDEDA API Support url: https://www.zededa.com/support email: support@zededa.com license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://{apiHost}/api variables: apiHost: default: invalid.invalid description: Connect from ZedUI to supply your verified API destination. security: - BearerToken: [] tags: - name: BulkJobOps externalDocs: description: ZEDEDA Product Documentation url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/jobs paths: /v1/jobs/name/{name}/objectType/{objectType}: get: tags: - BulkJobOps summary: Get asynchronous job request description: Get the configuration and status of an asynchronous job request record. operationId: BulkJobOps_GetJobByName parameters: - name: name description: >- User defined name of the job request, unique across the enterprise. Once object is created, name can’t be changed in: path required: true schema: type: string - name: objectType description: object type for which job has been created in: path required: true schema: type: string enum: - OBJECT_TYPE_UNSPECIFIED - OBJECT_TYPE_USER - OBJECT_TYPE_EDGE_NODE - OBJECT_TYPE_EDGE_APP - OBJECT_TYPE_IMAGE - OBJECT_TYPE_EDGE_APP_INSTANCE - OBJECT_TYPE_PROJECT - OBJECT_TYPE_NETWORK - OBJECT_TYPE_DATASTORE - OBJECT_TYPE_SERVICE - OBJECT_TYPE_SERVICE_INSTANCE - OBJECT_TYPE_ENTERPRISE - OBJECT_TYPE_ROLE - OBJECT_TYPE_CREDENTIAL - OBJECT_TYPE_NETWORK_INSTANCE - OBJECT_TYPE_VOLUME_INSTANCE - OBJECT_TYPE_REALM - OBJECT_TYPE_AUTHPROFILE - OBJECT_TYPE_POLICY - OBJECT_TYPE_APP_POLICY - OBJECT_TYPE_CLUSTER_INSTANCE - OBJECT_TYPE_PLUGIN - OBJECT_TYPE_DOC_POLICY - OBJECT_TYPE_ORCHESTRATOR_CLUSTER - OBJECT_TYPE_TAGS - OBJECT_TYPE_EDGE_NODE_INTERFACE - OBJECT_TYPE_DEPLOYMENT - OBJECT_TYPE_ENTITLEMENTS - OBJECT_TYPE_DATA_STREAM - OBJECT_TYPE_API_USAGE - OBJECT_TYPE_APP_INSTANCE_SNAPSHOT - OBJECT_TYPE_PATCH_ENVELOPE - OBJECT_TYPE_RESOURCE_USAGE_TRACK - OBJECT_TYPE_PATCH_ENVELOPE_REFERENCE - OBJECT_TYPE_DEV_PASSTHROUGH - OBJECT_TYPE_EDGE_NODE_CLUSTER - OBJECT_TYPE_ASSET_GROUP - OBJECT_TYPE_APP_PROFILE - OBJECT_TYPE_PROFILE_DEPLOYMENT - OBJECT_TYPE_ZKS_INSTANCE - OBJECT_TYPE_CLUSTER_GROUP - name: X-Request-Id in: header required: false description: User-Agent specified id to track a request schema: type: string responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/JobConfig' '400': description: >- Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters. content: application/json: schema: $ref: '#/components/schemas/ZsrvResponse' '401': description: >- Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused. content: application/json: schema: $ref: '#/components/schemas/ZsrvResponse' '403': description: >- Forbidden. The API gateway did not process the request because the requestor does not have edge-app level access permission for the operation or does not have access scope to the project. content: application/json: schema: $ref: '#/components/schemas/ZsrvResponse' '404': description: >- Not Found. The API gateway did not process the request because the requested resource could not be found. content: application/json: schema: $ref: '#/components/schemas/ZsrvResponse' '500': description: >- Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes. content: application/json: schema: $ref: '#/components/schemas/ZsrvResponse' '504': description: >- Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request. content: application/json: schema: $ref: '#/components/schemas/ZsrvResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' externalDocs: description: ZEDEDA Product Documentation url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/jobs components: schemas: JobConfig: type: object properties: name: type: string description: >- User defined name of the job request, unique across the enterprise. Once object is created, name can’t be changed maxLength: 256 minLength: 3 pattern: '[a-zA-Z0-9][a-zA-Z0-9_.-]+' x-zededa-source-issues: - code: inapplicable-constraint pointer: '#/definitions/JobConfig/properties/name' keyword: uniqueItems sourceValue: true id: type: string description: System defined universally unique Id of the job request readOnly: true pattern: >- [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} x-zededa-source-issues: - code: inapplicable-constraint pointer: '#/definitions/JobConfig/properties/id' keyword: uniqueItems sourceValue: true objectType: description: object type for which job has been created allOf: - $ref: '#/components/schemas/ObjectType' operationType: $ref: '#/components/schemas/BulkService' status: description: status of the job readOnly: true allOf: - $ref: '#/components/schemas/JobStatus' objectList: type: array items: type: string startTime: type: string format: date-time description: start time of the job readOnly: true finishTime: type: string format: date-time description: finish time of the job readOnly: true revision: description: system defined info readOnly: true allOf: - $ref: '#/components/schemas/ObjectRevision' individualOpStatus: type: object additionalProperties: type: string description: status of individual field of the given object readOnly: true selectionCriteria: description: selection criteria for the job readOnly: true allOf: - $ref: '#/components/schemas/SelectionCriteria' errorDetailOfJob: type: string description: detailed error with which job/task has failed readOnly: true title: type: string description: user or system specified title description: type: string description: user or system specified description projectId: type: string description: project Id in which job is getting created description: config required for job ops title: config required for job ops required: - name - objectType ZsrvResponse: type: object properties: operationType: title: |- Describes one of the operations type : possible values Read/Delete/Create/Update/List allOf: - $ref: '#/components/schemas/ZcOpsType' operationStatus: title: if this is log running job allOf: - $ref: '#/components/schemas/ZcOpsStatus' objectKind: type: string title: zedcloud object kind on which the operation was performed objectId: type: string title: Unique value identifies the object that was operated on objectName: type: string title: name of the object objectRevision: type: string title: |- object revision post the operation, note Read operation doesn't change the revision objectType: $ref: '#/components/schemas/ObjectType' operationTime: type: string title: time of operation startTime: type: string title: total time taken by operations endTime: type: string user: type: string title: the operation is performed on behalf of this user httpStatusCode: type: integer format: int32 title: http response httpStatusMsg: type: string title: summary of the error in text format jobId: type: string title: for tracking asynchronous tasks error: type: array items: $ref: '#/components/schemas/ZsrvError' title: |- one or more errors will be set if the operation failed i.e. httpStatusCode != 2xx googlerpcStatus: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: $ref: '#/components/schemas/protobufAny' ObjectType: type: string enum: - OBJECT_TYPE_UNSPECIFIED - OBJECT_TYPE_USER - OBJECT_TYPE_EDGE_NODE - OBJECT_TYPE_EDGE_APP - OBJECT_TYPE_IMAGE - OBJECT_TYPE_EDGE_APP_INSTANCE - OBJECT_TYPE_PROJECT - OBJECT_TYPE_NETWORK - OBJECT_TYPE_DATASTORE - OBJECT_TYPE_SERVICE - OBJECT_TYPE_SERVICE_INSTANCE - OBJECT_TYPE_ENTERPRISE - OBJECT_TYPE_ROLE - OBJECT_TYPE_CREDENTIAL - OBJECT_TYPE_NETWORK_INSTANCE - OBJECT_TYPE_VOLUME_INSTANCE - OBJECT_TYPE_REALM - OBJECT_TYPE_AUTHPROFILE - OBJECT_TYPE_POLICY - OBJECT_TYPE_APP_POLICY - OBJECT_TYPE_CLUSTER_INSTANCE - OBJECT_TYPE_PLUGIN - OBJECT_TYPE_DOC_POLICY - OBJECT_TYPE_ORCHESTRATOR_CLUSTER - OBJECT_TYPE_TAGS - OBJECT_TYPE_EDGE_NODE_INTERFACE - OBJECT_TYPE_DEPLOYMENT - OBJECT_TYPE_ENTITLEMENTS - OBJECT_TYPE_DATA_STREAM - OBJECT_TYPE_API_USAGE - OBJECT_TYPE_APP_INSTANCE_SNAPSHOT - OBJECT_TYPE_PATCH_ENVELOPE - OBJECT_TYPE_RESOURCE_USAGE_TRACK - OBJECT_TYPE_PATCH_ENVELOPE_REFERENCE - OBJECT_TYPE_DEV_PASSTHROUGH - OBJECT_TYPE_EDGE_NODE_CLUSTER - OBJECT_TYPE_ASSET_GROUP - OBJECT_TYPE_APP_PROFILE - OBJECT_TYPE_PROFILE_DEPLOYMENT - OBJECT_TYPE_ZKS_INSTANCE - OBJECT_TYPE_CLUSTER_GROUP default: OBJECT_TYPE_UNSPECIFIED BulkService: type: string enum: - BULK_SERVICE_UNSPECIFIED - BULK_SERVICE_BASEOS_UPDATE - BULK_SERVICE_APPINSTANCE_DEPLOY - BULK_SERVICE_APPINSTANCE_REFRESH - BULK_SERVICE_APPINSTANCE_PURGE - BULK_SERVICE_MODEL_IMPORT - BULK_SERVICE_BUNDLE_IMPORT - BULK_SERVICE_APPINSTANCE_CERT_UPDATE - BULK_SERVICE_APPINSTANCE_DELETE - BULK_SERVICE_BASEOS_UPDATE_RETRY - BULK_SERVICE_APPINSTANCE_UPDATE - BULK_SERVICE_DEVICE_TAG_UPDATE - BULK_SERVICE_DEVICE_TAG_DEPLOYMENT_UPDATE - BULK_SERVICE_DEVICE_PROJECT_AND_TARGET_UPDATE - BULK_SERVICE_DEPLOYMENT_CREATE - BULK_SERVICE_APPLY_PATCH_ENVELOPE default: BULK_SERVICE_UNSPECIFIED title: type of bulk operation JobStatus: type: string enum: - JOB_STATUS_UNSPECIFIED - JOB_STATUS_INITIALIZED - JOB_STATUS_READY - JOB_STATUS_INPROGRESS - JOB_STATUS_COMPLETED - JOB_STATUS_FAILED - JOB_STATUS_ABORTED default: JOB_STATUS_UNSPECIFIED description: job status. ObjectRevision: type: object properties: prev: type: string description: Previous curr: type: string description: Current Database version of the record createdAt: type: object format: date-time description: >- The time, in milliseconds since the epoch, when the record was created. createdBy: type: string description: 'User data: Created By' updatedAt: type: object format: date-time description: >- The time, in milliseconds since the epoch, when the record was last updated. updatedBy: type: string description: 'User data: Updated By' description: >- ObjectRevision store the user details, who has doent the necessary operation like Create Operation or update operation title: ObjectRevision is used to store the user information. required: - curr - createdAt - createdBy - updatedAt - updatedBy SelectionCriteria: type: object properties: projectId: type: string bundleId: type: string deviceIdList: type: array items: type: string ZcOpsType: type: string enum: - OPS_TYPE_UNSPECIFIED - OPS_TYPE_READ - OPS_TYPE_DELETE - OPS_TYPE_CREATE - OPS_TYPE_UPDATE - OPS_TYPE_LIST default: OPS_TYPE_UNSPECIFIED title: ZedCloud internal operation type ZcOpsStatus: type: string enum: - OPS_STATUS_UNSPECIFIED - OPS_STATUS_PENDING - OPS_STATUS_ONGOING - OPS_STATUS_COMPLETE default: OPS_STATUS_UNSPECIFIED description: >- - OPS_STATUS_PENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING - OPS_STATUS_ONGOING: system will start the operation, but at the time response was generated, operation is still ONGOING. - OPS_STATUS_COMPLETE: Even if the result of the operations may result in failure, but the OpsStatus will marked COMPLETE for almost all cases. title: ZedCloud internal operation status ZsrvError: type: object properties: ec: title: |- Enumrated error code, describes more granular numerical value than just httpStatus allOf: - $ref: '#/components/schemas/ZsrvErrorCode' location: type: string title: 'Ignore: Internal field only' details: type: string title: Field captures string description of details protobufAny: type: object properties: typeUrl: type: string value: type: string format: byte ZsrvErrorCode: type: string enum: - zMsgErrorNone - zMsgSucess - NotFound - AlreadyExists - VersionMismatch - RangeError - LargeResult - IncompleteData - InvalidData - FunctionUnsupported - NoMemory - SendFailure - Timeout - BadReqBody - BadReqParam - InvalidFieldFormat - UrlNotFound - ApiVersionNotSupported - Unauthorized - Forbidden - Conflict - NotModified - DependencyConflict - JsonFmtError - ProtoFmtError - CertError - DataBaseConnection - DBError - zMsgAccepted - zMsgCreated - PreConditionFailed - InternalServerError default: zMsgErrorNone description: |- - zMsgErrorNone: common validation errors - IncompleteData: message had fields that weren't filled in - InvalidData: message contained the field that wasn't expected - FunctionUnsupported: this feature unavailable on this version of device - InvalidFieldFormat: message contained the field that wasn't correctly formatted - JsonFmtError: Marshal / Unmarshal errors - DataBaseConnection: generic DB error title: ZedCould internal error code securitySchemes: BearerToken: type: http description: Bearer token for user session scheme: bearer ````