Add access configuration for external artifacts

Use this API to add access configuration information for accessing external artifacts referenced in the VNF package manifest so they can be downloaded.

The following elements of the request, example, and responses are described:

Request
Request headers
Request data
Request data example
Response codes
Response headers
Response data

Request

Table 1. Request
Aspect	Value
Endpoint URL	/api/etsi/vnfpkgm/v2/vnf_packages/<package-id>/ext_artifacts_access
HTTP Method	PUT

Request headers

Table 2. Request headers
Header	Value
Content-Type	application/json
Version	2.1.0

Request data

Table 3. Request data
Parameter	Type	Description	Required
artifact	object	The object that contains the access configuration information. The following parameters in this table are contained within this object. See examples for more details.	Yes
> artifactUri	string	The URI of an external artifact. Note: If address is SSL secured (https), a valid certificate must be added to the `ishtar` micro service; this is done via the API at: /api/certificates/ishtar/	Yes
> overrideUri	string	Not currently in use.	No
> authType	string	Possible values: BASIC OAUTH2_CLIENT_CREDENTIALS	Yes
>username	string	For BASIC authentication	No
>password	string	For BASIC authentication	No
> paramsOauth2ClientCredentials	object	Only required if authType is OAUTH2_CLIENT_CREDENTIALS. Fields to set within are: clientId clientPassword tokenEndpoint	No

Request data example

Example 1: BASIC authType

{
            "artifact": {

              "artifactUri": "http://127.0.0.1/path/to/images/abc-def-
         ghi/file.img",
              "authType" : "BASIC",
              "username" : "admin",
              "password" : "password"
            }
}

Example 1: OAUTH2 authType

{
             "artifact": {
	        "artifactUri": "http://127.0.0.1/path/to/images/abc-def-
         ghi/file.img",
              "overrideUri": "http://8.8.8.8/path/to/images/abc-1234-
         ghi/file.img",
              "authType": "OAUTH2_CLIENT_CREDENTIALS",
              "paramsOauth2ClientCredentials": {
                   "clientId": "aaaaa",
                   "clientPassword": "bbbbb",
                   "tokenEndpoint": "http://127.0.0.1/oauth2/"
                 }
        }
}

Response codes

Table 4. Response codes
HTTP status code	Description
200	When the external artifacts access configuration has been successfully uploaded and the onboarding status of the package is CREATED (i.e. no package has been uploaded yet).
202	When the external artifacts access configuration has been successfully uploaded and the onboarding status of the package is CREATED (i.e. no package has been uploaded yet).
400	The response body contains details about the error.
404	When no package for supplied ID is found.
409	Typically, this is due to the fact that the onboarding state of the VNF package has a value different from ERROR or CREATED.
500	Internal Server Error
4xx/5xx	In addition to the response codes defined in this table, any common error response codes.

Response headers

Table 5. Request headers
Header	Value
Content-Type	application/json

Response data

In the case of a 202 Accepted response, the response body content is empty.

In the case of a 200 OK response, the response body contains details of added external artifact access configuration, with password information redacted.

Example 200 Response:

{
            "artifact": {
               "artifactUri": "http://127.0.0.1/path/to/images/abc-def-
         ghi/file.img",
               "authType" : "BASIC",
               "username" : "admin"
            }
}