This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Create PrivateLink Endpoint

1: 1.4
2: 1.3
3: 1.2

1 - 1.4

post /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints

Description

create privateLink endpoint

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	cloud_function_id required	Cloud Functions ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		PrivateLinkEndpointCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpoint
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.4"

Request body

{
    "endpoint": {
        "alias": "sample",
        "service_id": "8c9f6c1c928a45b4bbd1e4da5531d656"
    }
}

Example HTTP response

Response 200

{
    "endpoint": {
        "endpoint_alias": "sample",
        "endpoint_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "state": "Active"
    }
}

2 - 1.3

post /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints

Description

create privateLink endpoint

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20260830

Parameters

Type	Name	Description	Schema	Default
path	cloud_function_id required	Cloud Functions ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		PrivateLinkEndpointCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpoint
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.3"

Request body

{
    "endpoint": {
        "alias": "sample",
        "service_id": "8c9f6c1c928a45b4bbd1e4da5531d656"
    }
}

Example HTTP response

Response 200

{
    "endpoint": {
        "endpoint_alias": "sample",
        "endpoint_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "state": "Active"
    }
}

3 - 1.2

post /v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints

Description

create privateLink endpoint

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260630

Parameters

Type	Name	Description	Schema	Default
path	cloud_function_id required	Cloud Functions ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		PrivateLinkEndpointCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpoint
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/cloud-functions/{cloud_function_id}/configurations/privatelink-endpoints

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = scf 1.2"

Request body

{
    "endpoint": {
        "alias": "sample",
        "service_id": "8c9f6c1c928a45b4bbd1e4da5531d656"
    }
}

Example HTTP response

Response 200

{
    "endpoint": {
        "endpoint_alias": "sample",
        "endpoint_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "state": "Active"
    }
}