Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateUploadUrl

Generates a pre-signed URL, request headers used to upload a code resource, and code artifact identifier for the uploaded resource.

You can upload your code resource to the URL with the request headers using any HTTP client.

Request Syntax


POST /uploadUrl HTTP/1.1
Content-type: application/json

{
   "scanName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

scanName

The name of the scan that will use the uploaded resource. CodeGuru Security uses the unique scan name to track revisions across multiple scans of the same resource. Use this scanName when you call CreateScan on the code resource you upload to this URL.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 140.

Pattern: ^[a-zA-Z0-9-_$:.]*$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "codeArtifactId": "string",
   "requestHeaders": { 
      "string" : "string" 
   },
   "s3Url": "string"
}