Renews the credentials for the upload with the specified ID.
Base Request
POST /api/upload/[id]/renewCredentials
where [id] is the alphanumeric ID for the upload.
Headers
Header Name | Description | Required | Values |
---|---|---|---|
Authorization | The access token | Required |
Bearer [access_token]
where [access_token] is a string generated when you complete authentication (see Getting Started) |
User-Agent | Identity of the client making the request to the server | Required |
[product]/[version]
where [product] is the name of the software you are using to make the request and [version] is the numbered version of the software (for example, MyCompanyProduct/1.0). For information on other types of values commonly included in user-agent request headers, see the User-Agent HTTP header reference section on the Mozilla developer documentation website. |
Accept | The format of the data to be returned | Optional | application/vnd.hxcs.v1+json |
Sample Request
POST /api/upload/[id]/renewCredentials Authorization: Bearer [access_token] User-Agent: MyCompanyProduct/1.0 Accept: application/vnd.hxcs.v1+json
Response
No response body is returned.
Status Codes and Errors
The following table lists the returned status codes.
Code | Description | Notes |
---|---|---|
200 | OK | The token has been refreshed successfully. |
401 | Not Authorized | Authentication has failed or was not provided. |
403 | Not Allowed | Access permissions are invalid or missing. |
404 | Not Found | The upload with the specified ID could not be found. |
501 | Not Implemented | The token could not be refreshed with the current upload handler. |