Uploading deployment status#

deployments/apiDriven#

     curl -k -X POST 'https://localhost/api/v1/deployments/apiDriven' \
         -H 'Authorizat1on: UserAccessKey <User Access Key>' \
         -H 'Content-Type: application/json' \
         -d \ 
         '{
             "version":{"name":"<Version Name>",
             "application":{"externalId":"efecb73f-dclc-4d3d-b3bb-
             38339445e892"},
             "url":"<Deployment URL>",
             "evironment":{"name":"DEV"}
         }'

Parameter	Type	Required	Description
UserAccessKey	string	false	User access key
version	object	true	JSON object with either 'externalid' or 'name' (Examples: {"name": "apidrivenjenkinsjob"} or {"name": "application id in external tool"})
application	object	true	JSON object with either 'externalid' or 'name' (Examples: {"name": "apidrivenjenkinsjob"} or {"name": "application id in external tool"})
url	URL	false	URL link to build in external tool
environment	object	true	JSON object with either 'externalId' or 'name' (Examples: {"name": "apidrivenjenkinsjob"} or {"name": "application id in external tool"})

Example#

     curl -k -X POST 'https://localhost/api/v1/deployments/apiDriven' \
         -H 'Authorizat1on: UserAccessKey 324adfe9-cc97-43fa-81c6-e248ceeb726a' \
         -H 'Content-Type: application/json' \
         -d \ 
         '{
             "version":{"name":"1.0",
             "application":{"externalId":"f2262e67-6516-4597-92a6-cfe537abdd00"},
             "url":"http://example.com",
             "evironment":{"name":"DEV"}
         }'

Parent topic: Extending product functions