Put Package

Available in Classic and VPC

Create or edit a Cloud Functions package.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
PUT	/ncf/api/v2/packages/{packageName}

Note

Singapore and Japan Regions are available only in the VPC environment.

Request headers

For information about the headers common to all Cloud Functions APIs, see Cloud Functions request headers.

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`packageName`	String	Required	Package name Enter 1-50 characters, including English letters, numbers, and special characters "-" and "_". It can't start with "-".

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`platform`	String	Optional	Platform type `vpc` (default) \| `classic`

Request body

You can include the following data in the body of your request: If there are no fields in the request body, it should be requested as {} empty JSON object.

Field	Type	Required	Description
`description`	String	Optional	Package description (byte) 0-3000
`parameters`	Object	Optional	Default parameters of the package JSON in the form of `{"key" : "value"}` Priority of applying parameters when running actions 1st priority: Runtime parameters passed at runtime 2nd priority: Default parameters of connected triggers 3rd priority: Default parameters in actions 4th priority: Default parameters of included packages

Request example

The request example is as follows:

curl --location --request PUT 'https://cloudfunctions.apigw.ntruss.com/ncf/api/v2/packages/package001?platform=vpc' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature} \
--data '{
    "description": "Create package",
    "parameters": {
        "name": "Cloud Funtions",
        "place": "Naver Cloud Platform"
    }
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`content`	String	-	Package creation and modification information
`content.description`	String	-	Package description
`content.name`	String	-	Package name
`content.namespace`	String	-	Namespace of the user
`content.parameters`	Object	-	Default parameters of the package
`content.resourceId`	String	-	Package's resource ID

Response status codes

For information about the HTTP status codes common to all Cloud Functions APIs, see Cloud Functions response status codes.

Response example

The response example is as follows:

{
    "content": {
        "description": "Create package",
        "name": "package001",
        "namespace": "****YBN*****",
        "parameters": {
            "name": "Cloud Funtions",
            "place": "Naver Cloud Platform"
        },
        "resourceId": "xS***"
    }
}