resources.configureNetwork

POST

/resources/{resourceId}/network-profile

curl --request POST \
  --url https://example.com/api/resources/example/network-profile \
  --header 'Content-Type: application/json' \
  --data '{ "networkProfile": { "internalPort": 1, "upstreamProtocol": "http", "exposureMode": "none", "targetServiceName": "example", "hostPort": 1 } }'

Configures ports, protocols, and exposure behavior for resource access. Public docs: /docs/resources/profiles/health-network/#resource-network-profile

Parameters

Path Parameters

resourceId

required

string

>= 1 characters

Request Body ^required

Media type application/json

object

networkProfile

required

object

internalPort

required

integer

> 0 <= 9007199254740991

upstreamProtocol

string

default: http

Allowed values: http tcp

exposureMode

string

default: reverse-proxy

Allowed values: none reverse-proxy direct-port

targetServiceName

string

>= 1 characters

hostPort

integer

> 0 <= 9007199254740991

Responses

200

OK

Media type application/json

object

id

required

string

Example ^generated

{
  "id": "example"
}