Needed Headers for all the API. \n
\n
Authorization Bearer + access_token (Generated From api/v1.1/auth/login API)\n
Content-Type application/json
This API endpoint allows you to upload files on the cloud. You can upload different files like user profile, device image, firmware file etc. For that, you need to send ModuleType, defining the type of file. The fileRefGuid is a reference guid, saying a file belongs to which module. For example, for a user profile, it requires a user guid to define that to which user the file belongs.
","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the file uploaded successfully and returns file details.","schema":{"$ref":"#/definitions/FileAddResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\ninvalid logged user or company."}},"parameters":[{"name":"fileRefGuid","in":"formData","description":"Reference Guid. \n Eg.This API endpoint lets you update a file on the cloud. For that, you need to send fileGuid in request url and updated file in the request body.
","parameters":[{"name":"fileGuid","in":"path","description":"File Guid","required":true,"type":"string","format":"uuid"},{"name":"RunTime","in":"formData","description":"","type":"string","required":false},{"name":"ModuleType","in":"formData","description":"Module type should be one of below items \nThis API endpoint permits you to delete a file from the cloud. For that, you need to send modelType and fileGuid in request url.
","parameters":[{"name":"moduleType","in":"path","description":"Module type should be one of below items\nThis API endpoint allows you to download files from the cloud. For that, you need to send receipeModuleType and fileRefGuid in request url.
","parameters":[{"name":"moduleType","in":"path","description":"Module type should be one of below items\nThis API endpoint allows you to download files from the cloud. For that, you need to send receipeModuleType and fileRefGuid in request url.
","parameters":[{"name":"uniqueId","in":"path","description":"uniqueId","required":true,"type":"string"},{"name":"parentUniqueId","in":"query","type":"string"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the file list received successfully.","schema":{"$ref":"#/definitions/FileDeleteResponse"}},"204":{"description":"Indicates that the file list not found."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\ninvalid logged user or company."}}}},"/api/v2.1/File/device-telemetry/{uniqueId}":{"get":{"tags":["File"],"summary":"Get device telemetry file url(s)","description":"This API endpoint allows you to download device telemetry file from the cloud. For that, you need to send uniqueId in request url.
","parameters":[{"name":"uniqueId","in":"path","description":"device uniqueId","required":true,"type":"string"},{"name":"imageViewer","in":"query","description":"Image Viewer","type":"boolean"},{"name":"fileGuid","in":"query","type":"string","format":"uuid"},{"name":"pageSize","in":"query","type":"integer","format":"int32"},{"name":"pageNumber","in":"query","type":"integer","format":"int32"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the device telemetry file received successfully."},"204":{"description":"Indicates that the file not found."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\ndevice not found, invalid logged user or company."}}}},"/api/v2.1/File/bulk":{"post":{"tags":["File"],"summary":"Upload multiple files","description":"This API endpoint allows you to upload multiple files on the cloud. You can upload different files like user profile, device image, firmware file etc. For that, you need to send ModuleType, defining the type of file. The fileRefGuid is a reference guid, saying a file belongs to which module. For example, for a user profile, it requires a user guid to define that to which user the file belongs.
","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the file uploaded successfully and returns files details.","schema":{"$ref":"#/definitions/BulkFileAddResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\ninvalid logged user or company."}},"parameters":[{"name":"fileRefGuid","in":"formData","description":"Reference Guid. \n Eg.This API endpoint allows you to upload files on the cloud. You can upload different files like user profile, device image, firmware file etc. For that, you need to send ModuleType, defining the type of file. The fileRefGuid is a reference guid, saying a file belongs to which module. For example, for a user profile, it requires a user guid to define that to which user the file belongs.
","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the file uploaded successfully and returns file details.","schema":{"$ref":"#/definitions/FileAddResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\ninvalid logged user or company."}},"parameters":[{"name":"ChunkFiles","in":"formData","description":"","type":"array","required":false},{"name":"RecipeGuid","in":"formData","description":"","type":"string","required":false,"format":"uuid"},{"name":"ModuleType","in":"formData","description":"Module type should be one of below items \nThis API endpoint allows you to upload multiple files on the cloud. You can upload different files like user profile, device image, firmware file etc. For that, you need to send ModuleType, defining the type of file. The fileRefGuid is a reference guid, saying a file belongs to which module. For example, for a user profile, it requires a user guid to define that to which user the file belongs.
","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the file uploaded successfully and returns files details.","schema":{"$ref":"#/definitions/BulkFileAddResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\ninvalid logged user or company."}},"parameters":[{"name":"fileRefGuid","in":"formData","description":"Reference Guid. \n Eg.This API endpoint permits you to delete artifact file from the cloud. For that, you need to send modelType and fileGuid in request url.
","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the file deleted successfully.","schema":{"$ref":"#/definitions/FileDeleteResponse"}},"204":{"description":"Indicates that the file not found."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\ninvalid logged user or company."}},"parameters":[{"name":"request","in":"body","description":"","schema":{"$ref":"#/definitions/ArtifactFileDeleteRequest"}}]}},"/api/v2.1/File/presigned-url":{"post":{"tags":["File"],"summary":"Generate Pre-Signed URL","description":"This API endpoint allows you to generate pre-signed url.
","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the pre signed url generated.","schema":{"$ref":"#/definitions/PreSignedURLResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\ninvalid logged user or company."}},"parameters":[{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/PreSignedURLRequest"}}]}},"/api/v2.1/File/recipe":{"post":{"tags":["File"],"summary":"Upload a Greengrass recipe file.","description":"This API endpoint allows you to upload files on the cloud.
","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the file uploaded successfully and returns file details.","schema":{"$ref":"#/definitions/FileAddResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\ninvalid logged user or company."}},"parameters":[{"name":"RecipeFile","in":"formData","description":"","type":"file","required":true}]}},"/api/v2.1/File/removeArtifactFileFromReceipe":{"post":{"tags":["File"],"summary":"Remove artifact file from recipe file","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the RemoveArtifactFile request completed successfully.","schema":{"$ref":"#/definitions/RemoveArtifactFileResponse"}}},"parameters":[{"name":"request","in":"body","description":"The request object","schema":{"$ref":"#/definitions/RemoveArtifactFileRequest"}}]}},"/api/v2.1/File/chunk/{moduleType}/initiate":{"post":{"tags":["File"],"summary":"Initiates a new file upload process.","parameters":[{"name":"moduleType","in":"path","required":true,"type":"string"},{"name":"request","in":"body","description":"The upload initialization request containing metadata like file name, content type, etc.","schema":{"$ref":"#/definitions/UploadInitRequest"}}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Returns the upload initiation response.","schema":{"$ref":"#/definitions/UploadInitResponse"}}}}},"/api/v2.1/File/chunk/{moduleType}/urls":{"post":{"tags":["File"],"summary":"Retrieves pre-signed URLs for multipart upload.","parameters":[{"name":"moduleType","in":"path","required":true,"type":"string"},{"name":"request","in":"body","description":"The request containing upload ID and part count.","schema":{"$ref":"#/definitions/PresignedUrlsRequest"}}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Returns the pre-signed URL response.","schema":{"$ref":"#/definitions/PresignedUrlsResponse"}}}}},"/api/v2.1/File/chunk/complete/{moduleType}":{"put":{"tags":["File"],"summary":"Completes the multipart upload process.","parameters":[{"name":"moduleType","in":"path","required":true,"type":"string"},{"name":"request","in":"body","description":"The request containing upload ID, key name, and part information.","schema":{"$ref":"#/definitions/CompleteUploadRequest"}}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Returns the complete upload response.","schema":{"$ref":"#/definitions/CompleteUploadResponse"}}}}},"/api/v2.1/File/retryFileAccess":{"post":{"tags":["File"],"summary":"Retry file access for a given recipe and artifact file name.","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the RetryFileAccess request completed successfully.","schema":{"$ref":"#/definitions/RetryFileAccessResponse"}}},"parameters":[{"name":"request","in":"body","description":"The request object","schema":{"$ref":"#/definitions/RetryFileAccessRequest"}}]}}},"security":[{"Bearer":[]}],"tags":[{"name":"File","description":"File Api List"}],"swagger":"2.0","definitions":{"ArtifactFileDeleteRequest":{"required":["artifactFileNames"],"type":"object","properties":{"artifactFileNames":{"type":"array","items":{"type":"string"}},"recipeGuid":{"type":"string","format":"uuid"}},"additionalProperties":false},"BulkFileAddResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/FileDetail"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"CompleteUploadRequest":{"type":"object","properties":{"fileName":{"type":"string","nullable":true},"uploadId":{"type":"string","nullable":true},"parts":{"type":"array","items":{"$ref":"#/definitions/PartETagDto"},"nullable":true}},"additionalProperties":false},"CompleteUploadResponse":{"type":"object","properties":{"data":{"type":"object","nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"ErrorModel":{"type":"object","properties":{"param":{"type":"string","nullable":true},"message":{"type":"string","nullable":true}},"additionalProperties":false},"ErrorsResponse":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"error":{"type":"array","items":{"$ref":"#/definitions/ErrorModel"},"nullable":true}},"additionalProperties":false},"FileAddResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/FileDetail"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"FileBaseDetail":{"type":"object","properties":{"guid":{"type":"string","nullable":true},"file":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fileDetails":{"type":"array","items":{"$ref":"#/definitions/UrlCheckResult"},"nullable":true}},"additionalProperties":false},"FileDeleteResponse":{"type":"object","properties":{"data":{"type":"object","nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"FileDetail":{"type":"object","properties":{"tag":{"type":"string","nullable":true},"operationId":{"type":"string","format":"uuid","nullable":true},"componentName":{"type":"string","nullable":true},"componentVersion":{"type":"string","nullable":true},"guid":{"type":"string","nullable":true},"file":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fileDetails":{"type":"array","items":{"$ref":"#/definitions/UrlCheckResult"},"nullable":true}},"additionalProperties":false},"FileUpdateResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/FileBaseDetail"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"PartETagDto":{"type":"object","properties":{"partNumber":{"type":"integer","format":"int32"},"eTag":{"type":"string","nullable":true}},"additionalProperties":false},"PreSignedURLDetail":{"type":"object","properties":{"guid":{"type":"string","nullable":true},"file":{"type":"string","nullable":true},"preSignedURL":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"tag":{"type":"string","nullable":true}},"additionalProperties":false},"PreSignedURLRequest":{"required":["fileRefGuid","moduleType"],"type":"object","properties":{"tag":{"type":"string","nullable":true},"fileName":{"type":"string","nullable":true},"fileRefGuid":{"type":"string","description":"Reference Guid. \n Eg.