API reference
account
$client->account->details() -> Account
Description
Returns account details for the authenticated user
Usage
$client->account->details();
$client->account->getMonthlyDetailedBillingSummary($year, $month, $request) -> AccountBillingSummary
Description
Returns a billing summary grouped by resource, including billing detail changes during the specified month. The API user must have permission to read billing details.
Usage
$client->account->getMonthlyDetailedBillingSummary(
'year',
'month',
new GetMonthlyDetailedBillingSummaryRequest([]),
);
Parameters
$year: string — Billing year.
$month: string — Billing month.
$username: ?string — Return the billing summary for this account instead of the calling account. Requires Partner API access and an existing association with the account.
$resourceId: ?string — Return details only for this resource UUID or IP address.
$client->account->getMonthlyBillingSummary($year, $month) -> AccountBillingSummaryResponse
Description
Returns a billing summary for the specified month. The API user must have permission to read billing details. This endpoint is deprecated; use the monthly billing summary with resource details instead.
Usage
$client->account->getMonthlyBillingSummary(
'year',
'month',
);
Parameters
$year: string — Billing year.
$month: string — Billing month.
$client->account->getCurrentNetworkUsage() -> AccountCurrentNetworkUsage
Description
Returns the latest Network Transfer Pool usage report for the account.
Usage
$client->account->getCurrentNetworkUsage();
$client->account->listAccounts($request) -> Accounts
Description
Returns the main account and its subaccounts. Account listing is available only to the main account.
Usage
$client->account->listAccounts(
new ListAccountsRequest([]),
);
Parameters
$label: ?string — Filter by label key or key-value pair. Repeat the parameter to require all labels. Label keys are matched case-insensitively.
$client->account->createMslmaSigningLink() -> AccountCreateMsLmaSigningLinkResponse
Description
Create a new Microsoft LMA signing link
Usage
$client->account->createMslmaSigningLink();
$client->account->getAccountNetworkTopUsage($request) -> AccountResourceNetworkUsage
Description
Returns the resources with the highest network usage.
Usage
$client->account->getAccountNetworkTopUsage(
new GetAccountNetworkTopUsageRequest([
'from' => new DateTime('2026-07-01T00:00:00Z'),
'to' => new DateTime('2026-07-01T00:00:00Z'),
'zone' => 'fi-hel1',
]),
);
Parameters
$from: DateTime — Start of the usage period.
$to: DateTime — End of the usage period.
$service: ?string — Filter by service type. Repeat the parameter to include multiple service types.
$zone: ?string — Filter by zone. Repeat the parameter to include multiple zones.
$accumulate: ?string — Accumulation period for the usage statistics.
$client->account->getAccountNetworkUsage($request) -> AccountNetworkUsage
Description
Returns network transfer statistics. JSON responses support a maximum time window of 31 days; CSV responses have no time-window limit. Select the output format with the Accept header using application/json or text/csv.
Usage
$client->account->getAccountNetworkUsage(
new GetAccountNetworkUsageRequest([
'from' => new DateTime('2026-07-01T00:00:00Z'),
'to' => new DateTime('2026-07-01T00:00:00Z'),
]),
);
Parameters
$from: DateTime — First measurement timestamp in RFC 3339 format.
$to: DateTime — Last measurement timestamp in RFC 3339 format.
$accumulate: ?string — Accumulate the transfer statistics by hour or day.
$client->account->getAccountResourceUsage() -> array
Description
Returns current resource usage counts for the account.
Usage
$client->account->getAccountResourceUsage();
$client->account->getMonthlyResourceBillingSummary($resourceId, $year, $month) -> AccountResourceBillingSummaryResponse
Description
Returns a billing summary for one resource during the specified month. The API user must have permission to read billing details.
Usage
$client->account->getMonthlyResourceBillingSummary(
'resource_id',
'year',
'month',
);
Parameters
$resourceId: string — Server UUID, storage UUID, or IP address.
$year: string — Billing year.
$month: string — Billing month.
$client->account->getAccountResourceNetworkUsage($request) -> AccountResourceNetworkUsage
Description
Returns network transfer statistics grouped by resource, service, and zone. JSON responses support a maximum time window of 31 days; CSV responses have no time-window limit. Select the output format with the Accept header using application/json or text/csv.
Usage
$client->account->getAccountResourceNetworkUsage(
new GetAccountResourceNetworkUsageRequest([
'from' => new DateTime('2026-07-01T00:00:00Z'),
'to' => new DateTime('2026-07-01T00:00:00Z'),
'resourceId' => '0414e0d7-4436-4037-9dd8-6eaf47dce599',
'zone' => 'fi-hel1',
]),
);
Parameters
$from: DateTime — Data start timestamp in RFC 3339 format.
$to: DateTime — Data end timestamp in RFC 3339 format.
$service: ?string — Limit results to a service type. Repeat the parameter to include multiple service types.
$resourceId: ?string — Limit results to this resource UUID.
$zone: ?string — Limit results to a zone. Repeat the parameter to include multiple zones.
$accumulate: ?string — Accumulate the transfer statistics by hour or day.
$client->account->createSubaccount($request)
Description
Creates a subaccount for the authenticated main account.
Usage
$client->account->createSubaccount(
new CreateSubaccountRequest([
'subAccount' => new CreateSubaccountRequestSubAccount([
'username' => 'myusername',
'password' => 'mysecr3tPassword',
'firstName' => 'first',
'lastName' => 'last',
'company' => 'my company name',
'vatNumber' => 'my vat number',
'address' => 'my address',
'postalCode' => '00130',
'city' => 'Helsinki',
'state' => '',
'country' => 'FIN',
'email' => 'user@example.com',
'phone' => '+358.31245434',
'language' => 'en',
'currency' => 'EUR',
'timezone' => 'Europe/Helsinki',
'allowApi' => AccountBooleanYesno::Yes->value,
'allowGui' => AccountBooleanYesno::No->value,
'roles' => new CreateSubaccountRequestSubAccountRoles([
'role' => [
'technical',
'billing',
'aux_billing',
],
]),
'labels' => [
new AccountLabel([
'key' => 'department',
'value' => 'it',
]),
],
'ipFilters' => new CreateSubaccountRequestSubAccountIpFilters([
'ipFilter' => [
'ip_filter',
],
]),
]),
]),
);
Parameters
$subAccount: CreateSubaccountRequestSubAccount
$client->account->deleteSubaccount($username)
Description
Deletes a subaccount from the authenticated main account.
Usage
$client->account->deleteSubaccount(
'username',
);
Parameters
$username: string — Subaccount username.
kubernetes
$client->kubernetes->listKubernetesClusters() -> array
Description
Returns a list of Kubernetes clusters.
Usage
$client->kubernetes->listKubernetesClusters();
$client->kubernetes->createKubernetesCluster($request) -> KubernetesCluster
Description
Creates a new Kubernetes cluster.
Usage
$client->kubernetes->createKubernetesCluster(
new KubernetesCluster([
'controlPlaneIpFilter' => [
'1.2.3.0/24',
'1.1.1.1',
],
'name' => 'example-cluster',
'network' => '33333333-3333-3333-333333333333',
'networkCidr' => '172.16.0.0/24',
'nodeGroups' => [
new KubernetesNodeGroup([
'count' => 4,
'kubeletArgs' => [
new KubernetesKubeletArg([
'key' => 'log-flush-frequency',
'value' => '5s',
]),
],
'labels' => [
new KubernetesLabel([
'key' => 'managedBy',
'value' => 'exampleDevelopmentTeam',
]),
new KubernetesLabel([
'key' => 'environment',
'value' => 'development',
]),
],
'name' => 'small',
'plan' => 'K8S-2xCPU-4GB',
'sshKeys' => [
'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV',
],
'storage' => '01000000-0000-4000-8000-000160010100',
'taints' => [
new KubernetesTaint([
'effect' => KubernetesEffect::NoSchedule->value,
'key' => 'environment',
'value' => 'development',
]),
],
]),
new KubernetesNodeGroup([
'count' => 8,
'kubeletArgs' => [
new KubernetesKubeletArg([
'key' => 'log-flush-frequency',
'value' => '15s',
]),
],
'labels' => [
new KubernetesLabel([
'key' => 'managedBy',
'value' => 'exampleStagingTeam',
]),
new KubernetesLabel([
'key' => 'environment',
'value' => 'staging',
]),
],
'name' => 'medium',
'plan' => 'K8S-4xCPU-8GB',
'sshKeys' => [
'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV',
],
'storage' => '01000000-0000-4000-8000-000160010100',
'taints' => [
new KubernetesTaint([
'effect' => KubernetesEffect::NoSchedule->value,
'key' => 'environment',
'value' => 'staging',
]),
],
]),
],
'zone' => 'de-fra1',
'version' => 'version',
'labels' => [
[
'key' => "env",
'value' => "prod",
],
[
'key' => "app",
'value' => "cats-dating-app",
],
],
]),
);
Parameters
$request: KubernetesCluster
$client->kubernetes->getKubernetesCluster($uuid) -> KubernetesCluster
Description
Returns Kubernetes cluster details by given uuid.
Usage
$client->kubernetes->getKubernetesCluster(
'uuid',
);
Parameters
$uuid: string — UUID
$client->kubernetes->deleteKubernetesCluster($uuid) -> KubernetesAccepted
Description
Deletes an existing Kubernetes cluster by given uuid.
Usage
$client->kubernetes->deleteKubernetesCluster(
'uuid',
);
Parameters
$uuid: string — UUID
$client->kubernetes->modifyKubernetesCluster($uuid, $request) -> KubernetesCluster
Description
Modifies an existing Kubernetes cluster by given {uuid}.
Usage
$client->kubernetes->modifyKubernetesCluster(
'uuid',
new KubernetesClusterPatch([
'controlPlaneIpFilter' => [
'1.2.3.0/24',
'1.1.1.1',
],
'labels' => [
[
'key' => "env",
'value' => "prod",
],
[
'key' => "app",
'value' => "cats-dating-app",
],
],
]),
);
Parameters
$uuid: string — UUID
$controlPlaneIpFilter: ?array
$labels: mixed
$plan: ?string
$client->kubernetes->getKubernetesClusterKubeconfig($uuid) -> KubernetesClusterKubeconfig
Description
Returns kubeconfig for Kubernetes cluster by given {uuid}.
Usage
$client->kubernetes->getKubernetesClusterKubeconfig(
'uuid',
);
Parameters
$uuid: string — UUID
$client->kubernetes->getKubernetesClusterAvailableUpgrades($uuid) -> KubernetesClusterAvailableUpgrades
Description
Returns a list of available versions that can be used to upgrade the cluster.
Usage
$client->kubernetes->getKubernetesClusterAvailableUpgrades(
'uuid',
);
Parameters
$uuid: string — UUID
$client->kubernetes->upgradeKubernetesCluster($uuid, $request) -> KubernetesClusterAvailableUpgradesPost
Description
Upgrades an existing Kubernetes cluster to specific version.
Usage
$client->kubernetes->upgradeKubernetesCluster(
'uuid',
new UpgradeKubernetesClusterRequest([
'body' => new KubernetesClusterAvailableUpgradesPost([
'version' => '1.31',
]),
]),
);
Parameters
$uuid: string — UUID
$request: KubernetesClusterAvailableUpgradesPost
$client->kubernetes->listKubernetesClusterNodeGroups($uuid) -> array
Description
Returns a list of available node groups of an existing Kubernetes cluster. Cluster is identified by given {uuid}.
A node group is a uniform set of worker nodes attached to a cluster.
Usage
$client->kubernetes->listKubernetesClusterNodeGroups(
'uuid',
);
Parameters
$uuid: string — UUID
$client->kubernetes->createKubernetesClusterNodeGroup($uuid, $request) -> KubernetesNodeGroup
Description
Creates a new node group to an existing Kubernetes cluster. Cluster is identified by given {uuid}.
Usage
$client->kubernetes->createKubernetesClusterNodeGroup(
'uuid',
new CreateKubernetesClusterNodeGroupRequest([
'body' => new KubernetesNodeGroup([
'count' => 4,
'kubeletArgs' => [
new KubernetesKubeletArg([
'key' => 'log-flush-frequency',
'value' => '5s',
]),
],
'labels' => [
new KubernetesLabel([
'key' => 'managedBy',
'value' => 'exampleDevelopmentTeam',
]),
new KubernetesLabel([
'key' => 'environment',
'value' => 'development',
]),
],
'name' => 'small',
'plan' => 'K8S-2xCPU-4GB',
'sshKeys' => [
'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV',
],
'storage' => '01000000-0000-4000-8000-000160010100',
'taints' => [
new KubernetesTaint([
'effect' => KubernetesEffect::NoSchedule->value,
'key' => 'environment',
'value' => 'development',
]),
],
]),
]),
);
Parameters
$uuid: string — UUID
$request: KubernetesNodeGroup
$client->kubernetes->getKubernetesClusterNodeGroup($uuid, $name) -> KubernetesNodeGroupDetails
Description
Returns node group details by given {node_group_name}. Cluster is identified by given {uuid}.
Usage
$client->kubernetes->getKubernetesClusterNodeGroup(
'uuid',
'name',
);
Parameters
$uuid: string — UUID
$name: string — Name
$client->kubernetes->deleteKubernetesClusterNodeGroup($uuid, $name) -> KubernetesAccepted
Description
Deletes an existing node group by given Kubernetes cluster {uuid} and {node_group_name}.
Usage
$client->kubernetes->deleteKubernetesClusterNodeGroup(
'uuid',
'name',
);
Parameters
$uuid: string — UUID
$name: string — Name
$client->kubernetes->modifyKubernetesClusterNodeGroup($uuid, $name, $request) -> KubernetesNodeGroup
Description
Modifies an existing node group of a cluster. Cluster is identified by given {uuid} and node group by {node_group_name}.
Usage
$client->kubernetes->modifyKubernetesClusterNodeGroup(
'uuid',
'name',
new KubernetesNodeGroupPatch([
'count' => 16,
]),
);
Parameters
$uuid: string — UUID
$name: string — Name
$count: int
$client->kubernetes->deleteKubernetesClusterNodeGroupNode($uuid, $name, $nodeName) -> KubernetesAccepted
Description
Deletes a node group node from a cluster (experimental). Cluster is identified by given {uuid}, node group by {name}, and node by {node-name}.
Usage
$client->kubernetes->deleteKubernetesClusterNodeGroupNode(
'uuid',
'name',
'node-name',
);
Parameters
$uuid: string — UUID
$name: string — Name
$nodeName: string — Node name
$client->kubernetes->listKubernetesPlans() -> array
Description
Returns a list of available Kubernetes cluster plans.
Usage
$client->kubernetes->listKubernetesPlans();
$client->kubernetes->listKubernetesVersions() -> array
Description
Returns a list of available Kubernetes cluster versions.
Usage
$client->kubernetes->listKubernetesVersions();
$client->kubernetes->listClusterAuthentication($uuid) -> array
Description
Returns all OIDC authentication issuer configurations for a cluster.
Usage
$client->kubernetes->listClusterAuthentication(
'uuid',
);
Parameters
$uuid: string — UUID
$client->kubernetes->createClusterAuthentication($uuid, $request) -> KubernetesAuthenticationIssuerConfig
Description
Creates a new OIDC authentication issuer configuration. The new entry is validated together with the cluster’s existing entries before being applied. Fails if an entry with the same name already exists.
Usage
$client->kubernetes->createClusterAuthentication(
'uuid',
new CreateClusterAuthenticationRequest([
'body' => new KubernetesAuthenticationIssuerConfig([
'name' => 'name',
'issuerUrl' => 'https://accounts.myoidcprovider.com',
'audiences' => [
'client-id-123',
],
]),
]),
);
Parameters
$uuid: string — UUID
$request: KubernetesAuthenticationIssuerConfig
$client->kubernetes->setClusterAuthentication($uuid, $request) -> array
Description
Replaces the entire set of OIDC authentication issuer configurations for a cluster with the supplied JSON list of issuers. The full set is validated before being applied. An empty list clears all issuers.
Usage
$client->kubernetes->setClusterAuthentication(
'uuid',
new SetClusterAuthenticationRequest([
'body' => [
new KubernetesAuthenticationIssuerConfig([
'name' => 'name',
'issuerUrl' => 'https://accounts.myoidcprovider.com',
'audiences' => [
'client-id-123',
],
]),
],
]),
);
Parameters
$uuid: string — UUID
$request: array
$client->kubernetes->importClusterAuthentication($uuid) -> array
Description
Replaces the entire set of OIDC authentication issuer configurations for a cluster with the supplied native kube-apiserver v1 AuthenticationConfiguration YAML document. Issuers are named deterministically from their issuer URL host. The top-level anonymous field is not supported and any configuration that would drop data is rejected.
Usage
$client->kubernetes->importClusterAuthentication(
'uuid',
);
Parameters
$uuid: string — UUID
$client->kubernetes->getClusterAuthentication($uuid, $name) -> KubernetesAuthenticationIssuerConfig
Usage
$client->kubernetes->getClusterAuthentication(
'uuid',
'name',
);
Parameters
$uuid: string — UUID
$name: string — Name
$client->kubernetes->updateClusterAuthentication($uuid, $name, $request) -> KubernetesAuthenticationIssuerConfig
Description
Updates an existing OIDC authentication issuer configuration. The name in the path is authoritative. The updated entry is validated together with the cluster’s other entries before being applied.
Usage
$client->kubernetes->updateClusterAuthentication(
'uuid',
'name',
new UpdateClusterAuthenticationRequest([
'body' => new KubernetesAuthenticationIssuerConfig([
'name' => 'name',
'issuerUrl' => 'https://accounts.myoidcprovider.com',
'audiences' => [
'client-id-123',
],
]),
]),
);
Parameters
$uuid: string — UUID
$name: string — Name
$request: KubernetesAuthenticationIssuerConfig
$client->kubernetes->deleteClusterAuthentication($uuid, $name)
Description
Removes an OIDC authentication issuer configuration by name.
Usage
$client->kubernetes->deleteClusterAuthentication(
'uuid',
'name',
);
Parameters
$uuid: string — UUID
$name: string — Name
$client->kubernetes->getKubernetesClusterOidcKubeconfig($uuid, $name, $request) -> KubernetesClusterKubeconfig
Description
Returns a kubeconfig for the cluster whose user authenticates via the kubelogin (kubectl oidc-login) exec credential plugin, using the cluster’s configured OIDC issuer identified by the name path parameter. The plugin (kubelogin) must be installed on the client. No long-lived credential is embedded. The OIDC client secret and any provider-specific kubelogin flags are not injected by the server; the returned kubeconfig includes comments describing how to add them.
Usage
$client->kubernetes->getKubernetesClusterOidcKubeconfig(
'uuid',
'name',
new GetKubernetesClusterOidcKubeconfigRequest([]),
);
Parameters
$uuid: string — UUID
$name: string — Name
$audience: ?string — Which of the issuer’s configured audiences to use as the OIDC client id in the generated kubeconfig. When omitted, the issuer’s first audience is used. Must match one of the issuer’s audiences.
currency
$client->currency->listCurrencies() -> CurrencyCurrencies
Description
Retrieves a list of supported currencies and their exchange rates relative to the account credit currency.
Usage
$client->currency->listCurrencies();
device
$client->device->getAvailablePassthroughDevices($request) -> array
Description
Returns a list of available passthrough devices.
Usage
$client->device->getAvailablePassthroughDevices(
new GetAvailablePassthroughDevicesRequest([]),
);
Parameters
$zone: ?string — Filter results to a specific zone.
$type: ?string — Filter results to a specific device type. The only valid type is “gpu” for now.
events
$client->events->listEvents($serverUuid, $offset, $count) -> Events
Description
Retrieves a list of events.
Usage
$client->events->listEvents(
'server_uuid',
1,
1,
);
Parameters
$serverUuid: string — Filter results to a specific server.
$offset: int — The number of items to skip before starting to collect the result set. Default is 0.
$count: int — The numbers of items to return.
ip_address
$client->ipAddress->listIpAddresses() -> IpAddressesResponse
Description
Retrieves a list of IP addresses.
Usage
$client->ipAddress->listIpAddresses();
$client->ipAddress->addIpAddress($request) -> IpAddressRequest
Description
Adds a new IP address.
Usage
$client->ipAddress->addIpAddress(
new AddIpAddressRequest([
'ipAddress' => new AddIpAddressRequestIpAddress([
'access' => 'access',
'family' => IpAddressIpFamily::IPv4->value,
]),
]),
);
Parameters
$ipAddress: AddIpAddressRequestIpAddress
$client->ipAddress->bulkModifyIpAddresses($request)
Description
Modifies attributes of multiple IP addresses in a single request.
Usage
$client->ipAddress->bulkModifyIpAddresses(
new BulkPatchIpAddressesRequestV13([
'ipAddresses' => [
new BulkPatchIpAddressesRequestV13IpAddressesItem([
'address' => 'address',
'mainAccountId' => 1000000,
'delegatedToAccountId' => 1000000,
'releasePolicy' => IpAddressIpReleasePolicy::Release->value,
]),
],
]),
);
Parameters
$ipAddresses: array
$client->ipAddress->getIpAddressDetails($address) -> IpAddressResponse
Description
Retrieves details of a specific IP address.
Usage
$client->ipAddress->getIpAddressDetails(
'address',
);
Parameters
$address: string — The IP address to retrieve details for.
$client->ipAddress->modifyIpAddress($address, $request) -> IpAddressRequest
Description
Modifies attributes of a specific IP address.
Usage
$client->ipAddress->modifyIpAddress(
'address',
new ModifyIpAddressRequestV10([
'ipAddress' => new ModifyIpAddressRequestV10IpAddress([
'ptrRecord' => 'host.example.com',
]),
]),
);
Parameters
$address: string — The IP address to modify.
$ipAddress: ModifyIpAddressRequestV10IpAddress
$client->ipAddress->deleteIpAddress($address)
Description
Deletes a specific IP address.
Usage
$client->ipAddress->deleteIpAddress(
'address',
);
Parameters
$address: string — The IP address to delete.
$client->ipAddress->patchModifyIpAddress($address, $request) -> IpAddressRequest
Description
Modifies attributes of a specific IP address.
Usage
$client->ipAddress->patchModifyIpAddress(
'address',
new PatchIpAddressRequestV13([
'ipAddress' => new PatchIpAddressRequestV13IpAddress([]),
]),
);
Parameters
$address: string — The IP address to modify.
$ipAddress: PatchIpAddressRequestV13IpAddress
network-peering
$client->networkPeering->listNetworkPeerings($request) -> NetworkPeerings
Description
Get a list of all peerings within the current account. Only peerings that refer to a network that the current account has access are returned.
It is also possible to filter network peering with label URL parameters, e.g.
?label=env or ?label=env%3Dprod. The URL parameter can be given multiple
times to add more filters (e.g. ?label=env%3Dprod&label=v2), where
only network peering that match all labels are returned.
Label keys are matched case insensitively.
Usage
$client->networkPeering->listNetworkPeerings(
new ListNetworkPeeringsRequest([
'uuid' => '0414e0d7-4436-4037-9dd8-6eaf47dce599',
'networkUuidLocal' => '0414e0d7-4436-4037-9dd8-6eaf47dce599',
'networkUuidPeer' => '0414e0d7-4436-4037-9dd8-6eaf47dce599',
]),
);
Parameters
$uuid: ?string — Filter by network peering UUID.
$networkUuidLocal: ?string — Filter by local network uuid.
$networkUuidPeer: ?string — Filter by peer network uuid.
$label: ?string — Label filter in the form key=value. Can be specified multiple times to filter by multiple labels.
$client->networkPeering->createNetworkPeering($request) -> NetworkPeering
Description
Network peerings are used to enable traffic between two networks that can be on different main accounts.
The peering must be established both ways before it’s considered as active. Peering is only supported between networks
of type private.
Note: you should only create peering between accounts and networks you trust. There is no limits on what traffic
can flow. The server firewall has no effect for private type networks.
It is required that both networks have a Router attached to the network.
Usage
$client->networkPeering->createNetworkPeering(
new NetworkPeeringCreate([
'configuredStatus' => NetworkPeeringCreateConfiguredStatus::Active->value,
'name' => 'Peering A->B',
'network' => new NetworkPeeringCreateNetwork([
'uuid' => '03126dc1-a69f-4bc2-8b24-e31c22d64712',
]),
'peerNetwork' => new NetworkPeeringCreatePeerNetwork([
'uuid' => '03585987-bf7d-4544-8e9b-5a1b4d74a333',
]),
]),
);
Parameters
$configuredStatus: ?string
$name: string
$network: NetworkPeeringCreateNetwork — Describes the local side of the peering
$peerNetwork: NetworkPeeringCreatePeerNetwork — Describes the peer side of the peering
$client->networkPeering->getNetworkPeering($peeringUuid) -> NetworkPeering
Description
Returns the state of an existing network peering.
Note that the peer_network field only contains the network details if the peering has been defined by both accounts.
Usage
$client->networkPeering->getNetworkPeering(
'peering_uuid',
);
Parameters
$peeringUuid: string — The network peering identifier.
$client->networkPeering->deleteNetworkPeering($peeringUuid)
Description
Deletes a network peering. It is required that the peering is in disabled state before delete is possible.
Usage
$client->networkPeering->deleteNetworkPeering(
'peering_uuid',
);
Parameters
$peeringUuid: string — The network peering identifier.
$client->networkPeering->modifyNetworkPeering($peeringUuid, $request) -> NetworkPeering
Description
Modifies attributes of an existing network peering.
Usage
$client->networkPeering->modifyNetworkPeering(
'peering_uuid',
new NetworkPeeringModify([
'configuredStatus' => NetworkPeeringModifyConfiguredStatus::Disabled->value,
'name' => 'Peering A->B modified',
]),
);
Parameters
$peeringUuid: string — The network peering identifier.
$configuredStatus: ?string
$name: ?string
network
$client->network->listNetworks($request) -> Networks
Description
Get a list of all networks.
It is also possible to filter networks with label URL parameters, e.g.
?label=env or ?label=env%3Dprod. URL parameter can be given multiple
times to add more filters (e.g. ?label=env%3Dprod&label=v2), where
only networks that match all labels are returned.
Label keys are matched case insensitively.
Usage
$client->network->listNetworks(
new ListNetworksRequest([]),
);
Parameters
$label: ?NetworkLabel — Filter networks by labels.
$client->network->createNetwork($request) -> Network
Description
Creates a new SDN private network that cloud servers from the same zone can be attached to.
Usage
$client->network->createNetwork(
new CreateNetworkRequest([
'network' => new CreateNetworkRequestNetwork([
'type' => NetworkType::Private_->value,
'name' => 'backend-net',
'zone' => 'fi-hel2',
'ipNetworks' => new CreateNetworkRequestNetworkIpNetworks([
'ipNetwork' => [
new CreateNetworkRequestNetworkIpNetworksIpNetworkItem([
'family' => NetworkIpFamily::IPv4->value,
'address' => '10.0.0.0/24',
'dhcp' => NetworkBooleanYesno::Yes->value,
]),
],
]),
]),
]),
);
Parameters
$network: CreateNetworkRequestNetwork
$client->network->listNetworkInterfaces() -> NetworkInterfaces
Description
Retrieves a list of network interfaces.
Usage
$client->network->listNetworkInterfaces();
$client->network->createNetworkInterface($request) -> NetworkInterface
Description
Creates a new network interface.
Usage
$client->network->createNetworkInterface(
new NetworkCreateInterfaceRequest([
'mainAccountId' => 123456,
'interface' => new NetworkCreateInterfaceRequestInterface([
'bootable' => NetworkBooleanYesno::No->value,
'network' => '8f6d1ec2-8f5e-4b67-8fcb-6fa9c1a8a001',
'sourceIpFiltering' => NetworkBooleanYesno::Yes->value,
'type' => NetworkType::Private_->value,
]),
]),
);
Parameters
$mainAccountId: ?int
$interface_: ?NetworkCreateInterfaceRequestInterface
$client->network->getNetworkInterfaceDetails($uuid) -> Network
Description
Retrieves details of a specific network interface.
Usage
$client->network->getNetworkInterfaceDetails(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — UUID of the network interface.
$client->network->deleteNetworkInterface($uuid)
Description
Deletes a specific network interface.
Usage
$client->network->deleteNetworkInterface(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — UUID of the network.
$client->network->getNetworkDetails($uuid) -> Network
Description
Retrieves details of a specific network.
Usage
$client->network->getNetworkDetails(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — UUID of the network.
$client->network->modifyNetwork($uuid, $request) -> Network
Description
Modifies the details of a specific SDN private network. The Utility and public networks cannot be modified.
Usage
$client->network->modifyNetwork(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new ModifyNetworkRequest([
'network' => new ModifyNetworkRequestNetwork([
'type' => NetworkType::Public_->value,
'name' => 'name',
'zone' => 'fi-hel1',
'tags' => new NetworkTags([
'tags' => new NetworkTagsTags([
'tag' => [
new NetworkTagsTagsTagItem([
'description' => 'Production servers',
'name' => 'PROD',
'servers' => new NetworkServers([
'server' => [
'0077fa3d-32db-4b09-9f5f-30d9e9afb565',
],
]),
]),
],
]),
]),
'labels' => new NetworkLabels([
'label' => [
new NetworkLabel([
'key' => 'env',
'value' => 'prod',
]),
new NetworkLabel([
'key' => 'team',
'value' => 'network',
]),
],
]),
'router' => '0414e0d7-4436-4037-9dd8-6eaf47dce599',
'grtExport' => 1000000,
'parentNetwork' => 'parent_network',
'ipNetworks' => new ModifyNetworkRequestNetworkIpNetworks([
'ipNetwork' => [
new ModifyNetworkRequestNetworkIpNetworksIpNetworkItem([
'family' => NetworkIpFamily::IPv4->value,
'address' => 'address',
]),
],
]),
'networkFeatures' => NetworkFeatures::AllowLinklocalAddress->value,
'mainAccountId' => 1000000,
]),
]),
);
Parameters
$uuid: string — UUID of the network.
$network: ModifyNetworkRequestNetwork
$client->network->deleteNetwork($uuid)
Description
Deletes an SDN private network. All attached cloud servers must first be detached before SDN private networks can be deleted. Utility and public networks can only be detached from servers by Releasing the corresponding IP addresses.
Usage
$client->network->deleteNetwork(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — UUID of the network.
audit-logs
$client->auditLogs->listAuditLogs($request) -> AuditLogsResponse
Description
Returns a list of audit log rows according to the query parameters. Note that this endpoint is paginated by default and the list is limited in results.
Pagination Upcloud-Total-Count header is included in the response to indicate the total number of audit logs available with the current query parameters (excluding limit and offset). The total count can be used for a number of pagination strategies. limit and offset query parameters can be used to finally paginate the results.
Usage
$client->auditLogs->listAuditLogs(
new ListAuditLogsRequest([
'q' => 'my_account',
'limit' => 50,
'offset' => 0,
'createdAfter' => new DateTime('2024-01-01T00:00:00Z'),
'createdBefore' => new DateTime('2024-12-31T23:59:59Z'),
]),
);
Parameters
$q: ?string — Filter audit logs using a keyword such as account username, resource ID or IP address.
$limit: ?int — Number of results to return (max 100, default 50)
$offset: ?int — Offset for retrieved results. (default 0)
$actions: ?string — List of actions to filter by
$origins: ?string — List of origins to filter by
$resourceTypes: ?string — List of resource types to filter by
$createdAfter: ?DateTime — List audit logs created after the given timestamp (including the time of timestamp). Format: ISO timestamp eg. 2024-01-01T23:45:56Z
$createdBefore: ?DateTime — List audit logs created before the given timestamp (including the time of timestamp). Format: ISO timestamp eg. 2024-01-01T23:45:56Z
$client->auditLogs->exportAuditLogs($request) -> AuditLogsResponse
Description
Export all audit logs for the authenticated account as CSV or JSON (up to 180 day limit). Note: Use the format parameter to specify output format; only JSON schema is documented here.
Usage
$client->auditLogs->exportAuditLogs(
new ExportAuditLogsRequest([]),
);
Parameters
$format: ?string — Export format: ‘csv’ or ‘json’ (default: csv)
$client->auditLogs->getAuditLog($cloudEventId) -> AuditLogsAuditLog
Description
Returns details of a single audit log event by its cloud event ID.
Usage
$client->auditLogs->getAuditLog(
'01HQXYZ123456789ABCDEFGHJK',
);
Parameters
$cloudEventId: string — Cloud event ID (ULID format)
$client->auditLogs->getFilterOptions() -> AuditLogsFilterOptionsResponse
Description
Returns lists of available resource types, actions, and origins for filtering.
Usage
$client->auditLogs->getFilterOptions();
partner
$client->partner->listPartnerAccounts() -> array
Description
Returns list of accounts associated with the partner.
Usage
$client->partner->listPartnerAccounts();
$client->partner->createPartnerAccount($request) -> PartnerAccount
Description
Creates new UpCloud account that will be linked to partner’s existing invoicing.
Usage
$client->partner->createPartnerAccount(
new PartnerCreateAccount([
'username' => 'newuser',
'password' => 'superSecret123',
]),
);
Parameters
$username: string
$password: string
$contactDetails: ?PartnerCreateAccountContactDetails
permission
$client->permission->listPermissions() -> Permissions
Description
Retrieves a list of permissions for sub-accounts to access resources owned by the main account.
Usage
$client->permission->listPermissions();
$client->permission->replacePermissions($request) -> Permissions
Description
Replaces the entire set of permissions for sub-accounts to access resources owned by the main account.
Usage
$client->permission->replacePermissions(
new Permission([]),
);
Parameters
$request: Permission
$client->permission->grantPermission($request) -> Permission
Description
Grants a permission for a sub-account to access a resource owned by the main account.
Usage
$client->permission->grantPermission(
new GrantPermissionRequest([
'body' => new Permission([]),
]),
);
Parameters
$skipTargetCheck: ?bool — If true, skips the check whether the target resource exists. Default is false.
$request: Permission
$client->permission->revokePermission($request)
Description
Revokes a permission for a sub-account to access a resource owned by the main account.
Usage
$client->permission->revokePermission(
new Permission([]),
);
Parameters
$request: Permission
$client->permission->revokeAllPermissionsByTarget($targetType, $targetIdentifier, $request)
Description
Revokes all permissions for sub-accounts to access a specific resource owned by the main account.
Usage
$client->permission->revokeAllPermissionsByTarget(
'target_type',
'target_identifier',
new RevokeAllPermissionsByTargetRequest([]),
);
Parameters
$targetType: string — The type of the target resource (e.g., “server”, “storage”).
$targetIdentifier: string — The identifier of the target resource.
$mainAccountId: ?int — If specified, revokes permissions for resources owned by the specified main account ID. Default is the current main account.
$client->permission->revokeAllPermissionsByUser($user)
Description
Revokes all permissions for a specific sub-account to access any resources owned by the main account.
Usage
$client->permission->revokeAllPermissionsByUser(
'user',
);
Parameters
$user: string — The username of the sub-account.
plan
$client->plan->listPlans() -> Plan
Description
Returns a list of available plans. All plans are available in all zones but pricing may differ. See List prices for how to obtain current price list.
In addition to listed plans, server can be freely configured with “custom” plan which allows freely scalable CPU cores, memory amount and storage resources. Note! Custom plans are available for new customers through contact with sales.
Usage
$client->plan->listPlans();
price
$client->price->getPrice($request) -> Prices
Description
Returns a price list.
Usage
$client->price->getPrice(
new GetPriceRequest([]),
);
Parameters
$zone: ?string — Filter results to a specific zone. Can be specified multiple times.
router
$client->router->listRouters($request) -> Routers
Description
Returns a list of all available routers associated with the current account.
It is also possible to filter routers with label URL parameters, e.g.
?label=env or ?label=env%3Dprod. URL parameter can be given multiple
times to add more filters (e.g. ?label=env%3Dprod&label=v2), where
only routers that match all labels are returned.
Label keys are matched case insensitively.
Usage
$client->router->listRouters(
new ListRoutersRequest([]),
);
Parameters
$label: ?RouterLabel — A label filter. Can be specified multiple times to create an AND condition. Format: label=key:value
$client->router->createRouter($request) -> Router
Description
Creates a new router. Routers can be used to connect multiple Private Networks. Cloud Servers on any attached network can communicate directly with each other.
Usage
$client->router->createRouter(
new RouterCreate([
'router' => new RouterCreateRouter([
'name' => 'Example router',
'staticRoutes' => [
new RouterCreateRouterStaticRoutesItem([
'name' => 'static-route-0',
'nexthop' => '192.168.1.1',
'route' => '0.0.0.0/0',
]),
],
]),
]),
);
Parameters
$router: RouterCreateRouter
$client->router->getRouter($router) -> Router
Description
Retrieves details of a specific router.
Usage
$client->router->getRouter(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$router: string — The router identifier.
$client->router->deleteRouter($router)
Description
Deletes a specific router.
Usage
$client->router->deleteRouter(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$router: string — The router identifier.
$client->router->modifyRouter($router, $request) -> Router
Description
Modifies attributes of a specific router.
Modifications to static routes of type service will be ignored.
Usage
$client->router->modifyRouter(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new RouterModify([
'routerModifyRouter' => new RouterModifyRouter([
'name' => 'Example router',
'staticRoutes' => [
new RouterModifyRouterStaticRoutesItem([
'name' => 'static-route-0',
'nexthop' => '192.168.1.1',
'route' => '0.0.0.0/0',
]),
],
'labels' => [
new RouterLabel([
'key' => 'service',
'value' => 'postgres cluster connectivity',
]),
],
]),
]),
);
Parameters
$router: string — The router identifier.
$routerModifyRouter: RouterModifyRouter
server-group
$client->serverGroup->listServerGroups($request) -> ServerGroups
Description
Retrieves a list of server groups.
Usage
$client->serverGroup->listServerGroups(
new ListServerGroupsRequest([]),
);
Parameters
$label: ?ServerGroupLabel — A label filter to apply. Format: key:value. Multiple labels can be specified by repeating the parameter.
$client->serverGroup->createServerGroup($request) -> ServerGroup
Description
Creates a new server group.
Usage
$client->serverGroup->createServerGroup(
new ServerGroupModify([
'serverGroup' => new ServerGroupModifyServerGroup([
'title' => 'edge-cluster-a',
'servers' => new ServerGroupServers([
'servers' => [
'00fce2f9-f9f4-46ff-86af-9e60f131f5cb',
],
]),
'labels' => new ServerGroupModifyServerGroupLabels([
'label' => [
new ServerGroupLabel([
'key' => 'env',
'value' => 'prod',
]),
],
]),
'antiAffinity' => ServerGroupAntiAffinity::Yes->value,
]),
]),
);
Parameters
$request: ServerGroupModify
$client->serverGroup->getServerGroup($uuid) -> ServerGroup
Description
Retrieves details of a specific server group.
Usage
$client->serverGroup->getServerGroup(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — The UUID of the server group to retrieve.
$client->serverGroup->deleteServerGroup($uuid)
Description
Deletes a specific server group.
Usage
$client->serverGroup->deleteServerGroup(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — The UUID of the server group to delete.
$client->serverGroup->modifyServerGroup($uuid, $request) -> ServerGroup
Description
Modifies an existing server group.
Usage
$client->serverGroup->modifyServerGroup(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new ModifyServerGroupRequest([
'body' => new ServerGroupModify([
'serverGroup' => new ServerGroupModifyServerGroup([
'title' => 'edge-cluster-a',
'servers' => new ServerGroupServers([
'servers' => [
'00fce2f9-f9f4-46ff-86af-9e60f131f5cb',
],
]),
'labels' => new ServerGroupModifyServerGroupLabels([
'label' => [
new ServerGroupLabel([
'key' => 'env',
'value' => 'prod',
]),
],
]),
'antiAffinity' => ServerGroupAntiAffinity::Yes->value,
]),
]),
]),
);
Parameters
$uuid: string — The UUID of the server group to modify.
$request: ServerGroupModify
$client->serverGroup->listServerGroupMembers($uuid) -> ServerGroupServers
Description
Retrieves a list of servers that are members of a specific server group.
Usage
$client->serverGroup->listServerGroupMembers(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — The UUID of the server group whose members are to be listed.
$client->serverGroup->addServerToGroup($uuid, $request)
Description
Adds a server to a specific server group.
Usage
$client->serverGroup->addServerToGroup(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new ServerGroupServerAdd([
'server' => new ServerGroupServerAddServer([
'uuid' => '0414e0d7-4436-4037-9dd8-6eaf47dce599',
]),
]),
);
Parameters
$uuid: string — The UUID of the server group to which the server will be added.
$server: ServerGroupServerAddServer
$client->serverGroup->removeServerFromGroup($uuid, $serverUuid)
Description
Removes a server from a specific server group.
Usage
$client->serverGroup->removeServerFromGroup(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — The UUID of the server group from which the server will be removed.
$serverUuid: string — The UUID of the server to remove from the group.
server
$client->server->listServers($request) -> GetServerList
Description
Returns the most relevant information for Cloud Servers associated with the current account.
Usage
$client->server->listServers(
new ListServersRequest([
'uuid' => '0414e0d7-4436-4037-9dd8-6eaf47dce599',
'host' => 7653311107,
'tag' => 'prod,web',
'limit' => 25,
'offset' => 0,
]),
);
Parameters
$label: ?string — Filter by label key or key-value pair using “key” or “key=value”. Repeat the parameter to require all labels.
$uuid: ?string — Filter by Cloud Server UUID. Repeat the parameter to match any of up to five UUIDs.
$host: ?int — Filter by Private Cloud host ID. Repeat the parameter to match any of up to five hosts.
$device: ?string — Filter by attached device using “type=gpu” or “type!=gpu”. Repeat the parameter for up to five filters.
$state: ?string — Filter by the current Cloud Server state.
$tag: ?string — Filter by tag name. Separate names with commas to match any tag or colons to require all tags.
$search: ?string — Search UUIDs, titles, hostnames, zones, zone descriptions, IP addresses, tags, and template names.
$sortBy: ?string — Field to sort by.
$orderBy: ?string — Sort direction. Only applied when sort_by is specified.
$limit: ?int — Maximum number of Cloud Servers to return.
$offset: ?int — Number of Cloud Servers to skip.
$client->server->createServer($request) -> CreateServerResponse
Description
Creates a new Cloud Server
Usage
$client->server->createServer(
new CreateServer([
'server' => new CreateServerServer([
'hostname' => 'my-server.example.com',
'loginUser' => new ServerLoginUser([
'sshKeys' => new ServerLoginUserSshKeys([
'sshKey' => [
'ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIO3t5AQcuv4+KxJ5rC75N8bW/e7eOq0k5Y2L7V1oH3Z5 user@example.com',
],
]),
'username' => 'upclouduser',
]),
'networking' => new ServerCreateNetworking([
'interfaces' => new ServerCreateNetworkingInterfaces([
'interface' => [
new ServerCreateNetworkingInterfacesInterfaceItem([
'ipAddresses' => new ServerCreateNetworkingInterfacesInterfaceItemIpAddresses([
'ipAddress' => [
new ServerCreateNetworkingInterfacesInterfaceItemIpAddressesIpAddressItem([
'family' => ServerIpFamily::IPv4->value,
]),
],
]),
'type' => ServerNetworkType::Public_->value,
]),
new ServerCreateNetworkingInterfacesInterfaceItem([
'ipAddresses' => new ServerCreateNetworkingInterfacesInterfaceItemIpAddresses([
'ipAddress' => [
new ServerCreateNetworkingInterfacesInterfaceItemIpAddressesIpAddressItem([
'family' => ServerIpFamily::IPv4->value,
]),
],
]),
'type' => ServerNetworkType::Utility->value,
]),
new ServerCreateNetworkingInterfacesInterfaceItem([
'ipAddresses' => new ServerCreateNetworkingInterfacesInterfaceItemIpAddresses([
'ipAddress' => [
new ServerCreateNetworkingInterfacesInterfaceItemIpAddressesIpAddressItem([
'family' => ServerIpFamily::IPv4->value,
]),
],
]),
'network' => '03000000-0000-4000-8000-000000000000',
'type' => ServerNetworkType::Private_->value,
]),
],
]),
]),
'plan' => '1xCPU-1GB',
'metadata' => ServerBooleanYesno::Yes->value,
'storageDevices' => new ServerStorageDevices([
'storageDevice' => [
new ServerStorageDevicesStorageDeviceItem([
'action' => ServerStorageDevicesStorageDeviceItemAction::Clone_->value,
'size' => 30,
'storage' => '01000000-0000-4000-8000-000020080100',
'tier' => 'maxiops',
'title' => 'Debian Trixie',
]),
],
]),
'title' => 'My Server',
'zone' => 'fi-hel1',
]),
]),
);
Parameters
$server: CreateServerServer
$client->server->listFirewallRulesetRelationships($rulesetUuid) -> FirewallRulesetRelatedServers
Description
Return Cloud Servers visible to the authenticated account that are related to a private firewall ruleset, including each Cloud Server’s private ruleset relationships.
Usage
$client->server->listFirewallRulesetRelationships(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$rulesetUuid: string — Firewall ruleset UUID
$client->server->getLabels() -> array
Description
Returns the unique label key-value pairs used by Cloud Servers accessible to the current account.
Usage
$client->server->getLabels();
$client->server->getServer($uuid) -> Server
Description
Returns detailed information about a Cloud Server.
Usage
$client->server->getServer(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Cloud Server UUID
$client->server->modifyServer($uuid, $request) -> Server
Description
Modifies an existing Cloud Server configuration.
Usage
$client->server->modifyServer(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new ModifyServer([
'server' => new ModifyServerServer([
'coreNumber' => 8,
'memoryAmount' => 16384,
'plan' => 'custom',
]),
]),
);
Parameters
$uuid: string — Cloud Server UUID
$server: ModifyServerServer
$client->server->deleteServer($uuid, $request)
Description
Deletes a stopped Cloud Server and releases its IP addresses. Deleting backups requires deleting the associated storage devices.
Usage
$client->server->deleteServer(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new DeleteServerRequest([]),
);
Parameters
$uuid: string — Cloud Server UUID
$storages: ?string — Whether to delete attached storage devices.
$backups: ?string — How to handle backups when deleting storage devices. The delete value is valid only when storages is set to a truthy value.
$client->server->attachPrivateFirewallRuleset($uuid, $request) -> ServerFirewallRulesetRelationship
Description
Attach a private, stateful firewall ruleset to a Cloud Server. The latest ruleset version is selected and applied to private network interfaces.
Usage
$client->server->attachPrivateFirewallRuleset(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new ServerAttachPrivateFirewallRuleset([
'firewallRuleset' => new ServerAttachPrivateFirewallRulesetFirewallRuleset([
'firewallRulesetUuid' => '190f56d8-4b3f-4a89-9e5f-320fbc3d17c8',
]),
]),
);
Parameters
$uuid: string — Cloud Server UUID
$firewallRuleset: ServerAttachPrivateFirewallRulesetFirewallRuleset — Private firewall ruleset to attach.
$client->server->cancelServerOperation($uuid)
Description
Cancels an operation while the Cloud Server is in maintenance state.
Usage
$client->server->cancelServerOperation(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Cloud Server UUID
$client->server->ejectCdrom($uuid) -> Server
Description
Eject the storage from the Cloud Server’s attached CD-ROM device.
Usage
$client->server->ejectCdrom(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Cloud Server UUID
$client->server->loadCdrom($uuid, $request) -> Server
Description
Load a storage of type normal or cdrom into the Cloud Server’s attached CD-ROM device. If media is already loaded, it is ejected first.
Usage
$client->server->loadCdrom(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new ServerLoadCdrom([
'storageDevice' => new ServerLoadCdromStorageDevice([
'storage' => '01000000-0000-4000-8000-000060010101',
]),
]),
);
Parameters
$uuid: string — Cloud Server UUID
$storageDevice: ServerLoadCdromStorageDevice — Storage to load into the attached CD-ROM device.
$client->server->detachPrivateFirewallRuleset($uuid, $request) -> ServerFirewallRulesetRelationship
Description
Detach a private firewall ruleset from a Cloud Server and reapply private-interface firewall rules.
Usage
$client->server->detachPrivateFirewallRuleset(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new ServerDetachPrivateFirewallRuleset([
'firewallRuleset' => new ServerDetachPrivateFirewallRulesetFirewallRuleset([
'firewallRulesetUuid' => '190f56d8-4b3f-4a89-9e5f-320fbc3d17c8',
]),
]),
);
Parameters
$uuid: string — Cloud Server UUID
$firewallRuleset: ServerDetachPrivateFirewallRulesetFirewallRuleset — Private firewall ruleset to detach.
$client->server->listFirewallRules($uuid) -> ServerFirewallRules
Description
Return the Cloud Server firewall rules in evaluation order. Changes to firewall rules can take 1-2 minutes to take effect.
Usage
$client->server->listFirewallRules(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Cloud Server UUID
$client->server->createFirewallRule($uuid, $request) -> ServerFirewallRule
Description
Create a firewall rule. Rules are evaluated in position order; if position is omitted, the rule is appended. Changes can take 1-2 minutes to take effect.
Usage
$client->server->createFirewallRule(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new ServerCreateFirewallRule([
'firewallRule' => new ServerCreateFirewallRuleFirewallRule([
'action' => ServerCreateFirewallRuleFirewallRuleAction::Accept->value,
'comment' => 'Allow SSH from the office network',
'destinationPortEnd' => '22',
'destinationPortStart' => '22',
'direction' => ServerCreateFirewallRuleFirewallRuleDirection::In->value,
'family' => ServerCreateFirewallRuleFirewallRuleFamily::IPv4->value,
'position' => '1',
'protocol' => ServerCreateFirewallRuleFirewallRuleProtocol::Tcp->value,
'sourceAddressEnd' => '192.0.2.255',
'sourceAddressStart' => '192.0.2.1',
]),
]),
);
Parameters
$uuid: string — Cloud Server UUID
$firewallRule: ServerCreateFirewallRuleFirewallRule
$client->server->updateFirewallRules($uuid, $request)
Description
Replace the Cloud Server’s complete firewall rule chain. Array order determines rule positions. Changes can take 1-2 minutes to take effect.
Usage
$client->server->updateFirewallRules(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new ServerUpdateFirewallRules([
'firewallRules' => new ServerUpdateFirewallRulesFirewallRules([
'firewallRule' => [
new ServerFirewallRuleItem([
'action' => ServerFirewallRuleItemAction::Accept->value,
'comment' => 'Allow SSH',
'destinationPortEnd' => '22',
'destinationPortStart' => '22',
'direction' => ServerFirewallRuleItemDirection::In->value,
'family' => ServerFirewallRuleItemFamily::IPv4->value,
'protocol' => ServerFirewallRuleItemProtocol::Tcp->value,
]),
new ServerFirewallRuleItem([
'action' => ServerFirewallRuleItemAction::Drop->value,
'direction' => ServerFirewallRuleItemDirection::In->value,
]),
],
]),
]),
);
Parameters
$uuid: string — Cloud Server UUID
$firewallRules: ServerUpdateFirewallRulesFirewallRules
$client->server->getFirewallRule($uuid, $position) -> ServerFirewallRule
Description
Return the firewall rule at the specified one-based position in the Cloud Server rule chain.
Usage
$client->server->getFirewallRule(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
1,
);
Parameters
$uuid: string — Cloud Server UUID
$position: int — Firewall rule position
$client->server->deleteFirewallRule($uuid, $position)
Description
Delete the firewall rule at the specified one-based position. Remaining rules are renumbered. Changes can take 1-2 minutes to take effect.
Usage
$client->server->deleteFirewallRule(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
1,
);
Parameters
$uuid: string — Cloud Server UUID
$position: int — Firewall rule position
$client->server->listPrivateFirewallRulesetRelationships($uuid) -> ServerFirewallRulesetRelationships
Description
Return all private firewall ruleset relationships configured for a Cloud Server.
Usage
$client->server->listPrivateFirewallRulesetRelationships(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Cloud Server UUID
$client->server->listServerGpUs($uuid) -> ServerGpus
Description
Returns GPUs attached to a Cloud Server.
Usage
$client->server->listServerGpUs(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Cloud Server UUID
$client->server->getServerNetworking($uuid) -> ServerNetworkingResponse
Description
Return all network interfaces and IP addresses configured for a Cloud Server.
Usage
$client->server->getServerNetworking(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Cloud Server UUID
$client->server->addServerInterface($uuid, $request) -> ServerInterfaceResponse
Description
Add a network interface to a stopped Cloud Server. A private interface must identify the SDN network to attach. The combined limit of network interfaces and storage devices is 24.
Usage
$client->server->addServerInterface(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new ServerAddInterface([
'interface' => new ServerAddInterfaceInterface([
'ipAddresses' => new ServerAddInterfaceInterfaceIpAddresses([
'ipAddress' => [
new ServerAddInterfaceInterfaceIpAddressesIpAddressItem([
'address' => '10.0.0.20',
'dhcpProvided' => ServerBooleanYesno::Yes->value,
'family' => ServerIpFamily::IPv4->value,
]),
],
]),
'network' => '0374ce47-4303-4490-987d-32dc96cfd79b',
'sourceIpFiltering' => ServerBooleanYesno::Yes->value,
'type' => ServerNetworkType::Private_->value,
]),
]),
);
Parameters
$uuid: string — Cloud Server UUID
$interface_: ServerAddInterfaceInterface
$client->server->modifyServerInterface($uuid, $index, $request) -> ServerInterfaceResponse
Description
Modify the IP addresses, source IP filtering, boot setting, or index of a network interface on a stopped Cloud Server. Changing the interface network or type is not supported.
Usage
$client->server->modifyServerInterface(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
1,
new ServerModifyInterface([
'interface' => new ServerModifyInterfaceInterface([
'bootable' => ServerBooleanYesno::Yes->value,
'index' => 5,
'sourceIpFiltering' => ServerBooleanYesno::No->value,
]),
]),
);
Parameters
$uuid: string — Cloud Server UUID
$index: int — Network interface index
$interface_: ServerModifyInterfaceInterface
$client->server->deleteServerInterface($uuid, $index)
Description
Delete a network interface from a stopped Cloud Server. IP addresses attached to the interface are released according to their release policies.
Usage
$client->server->deleteServerInterface(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
1,
);
Parameters
$uuid: string — Cloud Server UUID
$index: int — Network interface index
$client->server->addServerInterfaceIpAddress($uuid, $index, $request) -> ServerIpAddressInterfaceResponse
Description
Add an IPv4 or IPv6 address to a private network interface. The interface cannot contain addresses from both families and can have at most five addresses.
Usage
$client->server->addServerInterfaceIpAddress(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
1,
new ServerAddIpAddress([
'ipAddress' => new ServerAddIpAddressIpAddress([
'address' => '10.0.0.30',
'family' => ServerIpFamily::IPv4->value,
]),
]),
);
Parameters
$uuid: string — Cloud Server UUID
$index: int — Network interface index
$force: ?string — Move the address from another interface when that interface can retain its required minimum number of addresses
$ipAddress: ServerAddIpAddressIpAddress
$client->server->deleteServerInterfaceIpAddress($uuid, $index, $ip)
Description
Delete an IP address from a private network interface. At least one IP address must remain attached to the interface.
Usage
$client->server->deleteServerInterfaceIpAddress(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
1,
'ip',
);
Parameters
$uuid: string — Cloud Server UUID
$index: int — Network interface index
$ip: string — IP address to delete
$client->server->rebuildServer($uuid, $request) -> Server
Description
Reinstalls a stopped Cloud Server from a public template.
Usage
$client->server->rebuildServer(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new ServerRebuild([
'serverRebuild' => new ServerRebuildServerRebuild([
'cloneSource' => '01000000-0000-4000-8000-000020050100',
'deleteDetachedDisk' => ServerLegacyBoolean::Yes->value,
'detachDisk' => '0169b4f8-051c-4a86-9484-f5b798249949',
'encrypted' => ServerLegacyBoolean::Yes->value,
'loginUser' => new ServerRebuildServerRebuildLoginUser([
'createPassword' => ServerLegacyBoolean::No->value,
'sshKeys' => new ServerRebuildServerRebuildLoginUserSshKeys([
'sshKey' => [
'ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIEexamplekey user@example',
],
]),
'username' => 'debian',
]),
'passwordDelivery' => ServerRebuildServerRebuildPasswordDelivery::None->value,
'storageTitle' => 'Rebuilt system disk',
]),
]),
);
Parameters
$uuid: string — Cloud Server UUID
$serverRebuild: ServerRebuildServerRebuild
$client->server->relocateServer($uuid, $request) -> Server
Description
Relocates a stopped Cloud Server to another zone in the same physical location (datacenter).
Usage
$client->server->relocateServer(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new RelocateServer([
'zone' => 'fi-hel2',
]),
);
Parameters
$uuid: string — Cloud Server UUID
$zone: string
$client->server->getRemoteAccessDetails($uuid) -> ServerRemoteAccessDetails
Description
Returns remote access settings and VNC connection details for a Cloud Server.
Usage
$client->server->getRemoteAccessDetails(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Cloud Server UUID
$client->server->restartServer($uuid, $request) -> Server
Description
Stops and starts a Cloud Server in started state.
Usage
$client->server->restartServer(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new RestartServer([
'restartServer' => new RestartServerRestartServerStopType([
'stopType' => RestartServerRestartServerStopTypeStopType::Hard->value,
]),
]),
);
Parameters
$uuid: string — Cloud Server UUID
$restartServer: mixed
$client->server->startServer($uuid, $request) -> Server
Description
Starts a Cloud Server in stopped state.
Usage
$client->server->startServer(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new StartServer([
'server' => new StartServerServer([
'host' => 8055964291,
'startType' => StartServerServerStartType::Sync->value,
]),
]),
);
Parameters
$uuid: string — Cloud Server UUID
$server: StartServerServer
$client->server->getCpuStats($uuid) -> ServerCpuStats
Description
Returns CPU usage statistics for all supported periods.
Usage
$client->server->getCpuStats(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Cloud Server UUID
$client->server->getCpuStatsByPeriod($uuid, $period) -> ServerCpuStats
Description
Returns CPU usage statistics for the selected period.
Usage
$client->server->getCpuStatsByPeriod(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
ServerStatsPeriod::Daily->value,
);
Parameters
$uuid: string — Cloud Server UUID
$period: string — Statistics period.
$client->server->getDiskStats($uuid, $type) -> ServerDiskStats
Description
Returns aggregate disk read and write statistics for all supported periods.
Usage
$client->server->getDiskStats(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
GetDiskStatsRequestType::Bytes->value,
);
Parameters
$uuid: string — Cloud Server UUID
$type: string — Measure disk activity as transferred bytes or I/O requests.
$client->server->getDiskStatsByPeriod($uuid, $type, $period) -> ServerDiskStats
Description
Returns aggregate disk read and write statistics for the selected period.
Usage
$client->server->getDiskStatsByPeriod(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
GetDiskStatsByPeriodRequestType::Bytes->value,
ServerStatsPeriod::Daily->value,
);
Parameters
$uuid: string — Cloud Server UUID
$type: string — Measure disk activity as transferred bytes or I/O requests.
$period: string — Statistics period.
$client->server->getNetworkStats($uuid, $type) -> ServerNetworkStats
Description
Returns aggregate inbound and outbound network statistics for all interfaces and periods.
Usage
$client->server->getNetworkStats(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
ServerStatsNetworkType::Bytes->value,
);
Parameters
$uuid: string — Cloud Server UUID
$type: string — Measure network activity as transferred bytes or packets.
$client->server->getNetworkStatsByNetwork($uuid, $type, $network) -> ServerNetworkStats
Description
Returns inbound and outbound network statistics for the selected network type and all periods.
Usage
$client->server->getNetworkStatsByNetwork(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
ServerStatsNetworkType::Bytes->value,
ServerNetworkType::Public_->value,
);
Parameters
$uuid: string — Cloud Server UUID
$type: string — Measure network activity as transferred bytes or packets.
$network: string — Network access type to aggregate.
$client->server->getNetworkStatsByNetworkAndPeriod($uuid, $type, $network, $period) -> ServerNetworkStats
Description
Returns inbound and outbound network statistics for the selected network type and period.
Usage
$client->server->getNetworkStatsByNetworkAndPeriod(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
ServerStatsNetworkType::Bytes->value,
ServerNetworkType::Public_->value,
ServerStatsPeriod::Daily->value,
);
Parameters
$uuid: string — Cloud Server UUID
$type: string — Measure network activity as transferred bytes or packets.
$network: string — Network access type to aggregate.
$period: string — Statistics period.
$client->server->stopServer($uuid, $request) -> Server
Description
Stops a Cloud Server in started state.
Usage
$client->server->stopServer(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new StopServer([
'stopServer' => new StopServerStopServer([
'stopType' => StopServerStopServerStopType::Soft->value,
'timeout' => '60',
]),
]),
);
Parameters
$uuid: string — Cloud Server UUID
$stopServer: StopServerStopServer
$client->server->attachStorageDevice($uuid, $request) -> Server
Description
Attach a storage resource as a disk or CD-ROM device to a Cloud Server. SCSI and virtio disks can be attached while the Cloud Server is started; IDE and CD-ROM devices require a stopped Cloud Server. An empty CD-ROM device can be attached without specifying a storage resource.
Usage
$client->server->attachStorageDevice(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new ServerAttachStorage([
'storageDevice' => new ServerAttachStorageStorageDevice([
'address' => 'virtio:0',
'bootDisk' => 1,
'storage' => '012580a1-32a1-466e-a323-689ca16f2d43',
'type' => ServerAttachStorageStorageDeviceType::Disk->value,
]),
]),
);
Parameters
$uuid: string — Cloud Server UUID
$storageDevice: ServerAttachStorageStorageDevice — Storage device to attach.
$client->server->detachStorageDevice($uuid, $request) -> Server
Description
Detach a storage device identified by its device address or storage resource UUID. IDE and CD-ROM devices cannot be detached while the Cloud Server is started.
Usage
$client->server->detachStorageDevice(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new ServerDetachStorage([
'storageDevice' => [
'address' => "virtio:0",
],
]),
);
Parameters
$uuid: string — Cloud Server UUID
$storageDevice: mixed
$client->server->getVncDetails($uuid) -> ServerRemoteAccessDetails
Description
Returns VNC connection details and remote access settings for a Cloud Server.
Usage
$client->server->getVncDetails(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Cloud Server UUID
server_size
$client->serverSize->listServerSizes() -> ServerSizes
Description
Retrieves a list of available server sizes (combinations of memory and CPU cores).
Usage
$client->serverSize->listServerSizes();
$client->serverSize->getServerSizeLimits() -> ServerSizeLimits
Description
Retrieves the minimum and maximum limits for server sizes, including any zone-specific limits for private zones.
Usage
$client->serverSize->getServerSizeLimits();
storage
$client->storage->getStorageList($request) -> Storages
Description
Returns all storage resources accessible to the account. The results can be filtered by labels or a title and UUID search, sorted, and paginated.
Usage
$client->storage->getStorageList(
new GetStorageListRequest([
'label' => 'environment',
'search' => 'database',
'limit' => 25,
'offset' => 0,
]),
);
Parameters
$label: ?string — Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.
$search: ?string — Search storage resource titles and UUIDs by partial match.
$sortBy: ?string — Field by which to sort the results.
$orderBy: ?string — Sort direction. Used only when sort_by is specified.
$limit: ?int — Maximum number of storage resources to return.
$offset: ?int — Number of storage resources to skip before returning results.
$client->storage->createStorage($request) -> CreateStorageResponse
Description
Creates a block storage resource in a specific zone. The new block storage is not attached to a Cloud Server.
Usage
$client->storage->createStorage(
new CreateStorageRequest([
'storage' => new CreateStorageRequestStorage([
'backupRule' => new StorageBackupRule([
'interval' => StorageBackupRuleInterval::Daily->value,
'time' => '0400',
'retention' => '7',
]),
'encrypted' => StorageEncrypted::Yes->value,
'labels' => [
new StorageLabel([
'key' => 'environment',
'value' => 'production',
]),
],
'size' => 50,
'tier' => StorageTier::Maxiops->value,
'title' => 'Block Storage 1',
'zone' => 'fi-hel1',
]),
]),
);
Parameters
$storage: CreateStorageRequestStorage — Block storage creation parameters.
$client->storage->getStorageListByBackup($request) -> Storages
Description
Returns accessible storage resources whose type is backup.
Usage
$client->storage->getStorageListByBackup(
new GetStorageListByBackupRequest([
'label' => 'environment',
'search' => 'database',
'limit' => 25,
'offset' => 0,
]),
);
Parameters
$label: ?string — Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.
$search: ?string — Search storage resource titles and UUIDs by partial match.
$sortBy: ?string — Field by which to sort the results.
$orderBy: ?string — Sort direction. Used only when sort_by is specified.
$limit: ?int — Maximum number of storage resources to return.
$offset: ?int — Number of storage resources to skip before returning results.
$client->storage->getStorageListByCdrom($request) -> Storages
Description
Returns accessible storage resources whose type is cdrom.
Usage
$client->storage->getStorageListByCdrom(
new GetStorageListByCdromRequest([
'label' => 'environment',
'search' => 'database',
'limit' => 25,
'offset' => 0,
]),
);
Parameters
$label: ?string — Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.
$search: ?string — Search storage resource titles and UUIDs by partial match.
$sortBy: ?string — Field by which to sort the results.
$orderBy: ?string — Sort direction. Used only when sort_by is specified.
$limit: ?int — Maximum number of storage resources to return.
$offset: ?int — Number of storage resources to skip before returning results.
$client->storage->getFavoriteStorageList() -> Storages
Description
Returns the public templates and CD-ROM images that the account has marked as favorites.
Usage
$client->storage->getFavoriteStorageList();
$client->storage->getStorageListByNormal($request) -> Storages
Description
Returns accessible Block Storage resources whose type is normal.
Usage
$client->storage->getStorageListByNormal(
new GetStorageListByNormalRequest([
'label' => 'environment',
'search' => 'database',
'limit' => 25,
'offset' => 0,
]),
);
Parameters
$label: ?string — Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.
$search: ?string — Search storage resource titles and UUIDs by partial match.
$sortBy: ?string — Field by which to sort the results.
$orderBy: ?string — Sort direction. Used only when sort_by is specified.
$limit: ?int — Maximum number of storage resources to return.
$offset: ?int — Number of storage resources to skip before returning results.
$client->storage->getStorageListByPrivateAccess($request) -> Storages
Description
Returns accessible storage resources whose access type is private.
Usage
$client->storage->getStorageListByPrivateAccess(
new GetStorageListByPrivateAccessRequest([
'label' => 'environment',
'search' => 'database',
'limit' => 25,
'offset' => 0,
]),
);
Parameters
$label: ?string — Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.
$search: ?string — Search storage resource titles and UUIDs by partial match.
$sortBy: ?string — Field by which to sort the results.
$orderBy: ?string — Sort direction. Used only when sort_by is specified.
$limit: ?int — Maximum number of storage resources to return.
$offset: ?int — Number of storage resources to skip before returning results.
$client->storage->getStorageListByPublicAccess($request) -> Storages
Description
Returns accessible storage resources whose access type is public.
Usage
$client->storage->getStorageListByPublicAccess(
new GetStorageListByPublicAccessRequest([
'label' => 'environment',
'search' => 'database',
'limit' => 25,
'offset' => 0,
]),
);
Parameters
$label: ?string — Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.
$search: ?string — Search storage resource titles and UUIDs by partial match.
$sortBy: ?string — Field by which to sort the results.
$orderBy: ?string — Sort direction. Used only when sort_by is specified.
$limit: ?int — Maximum number of storage resources to return.
$offset: ?int — Number of storage resources to skip before returning results.
$client->storage->getStorageListByTemplate($request) -> Storages
Description
Returns accessible storage resources whose type is template.
Usage
$client->storage->getStorageListByTemplate(
new GetStorageListByTemplateRequest([
'label' => 'environment',
'search' => 'database',
'limit' => 25,
'offset' => 0,
]),
);
Parameters
$label: ?string — Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.
$search: ?string — Search storage resource titles and UUIDs by partial match.
$sortBy: ?string — Field by which to sort the results.
$orderBy: ?string — Sort direction. Used only when sort_by is specified.
$limit: ?int — Maximum number of storage resources to return.
$offset: ?int — Number of storage resources to skip before returning results.
$client->storage->getStorageListByTypeAndAccess($type, $access, $request) -> Storages
Description
Returns accessible storage resources matching both the requested storage type and access type.
Usage
$client->storage->getStorageListByTypeAndAccess(
StorageType::Normal->value,
StorageAccessFilter::Public_->value,
new GetStorageListByTypeAndAccessRequest([
'label' => 'environment',
'search' => 'database',
'limit' => 25,
'offset' => 0,
]),
);
Parameters
$type: string — Storage resource type to return.
$access: string — Storage resource access type to return.
$label: ?string — Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.
$search: ?string — Search storage resource titles and UUIDs by partial match.
$sortBy: ?string — Field by which to sort the results.
$orderBy: ?string — Sort direction. Used only when sort_by is specified.
$limit: ?int — Maximum number of storage resources to return.
$offset: ?int — Number of storage resources to skip before returning results.
$client->storage->getStorageInfo($uuid) -> Storage
Description
Returns detailed information about a storage resource, including its current state, attachments, labels, and backup configuration when applicable.
Usage
$client->storage->getStorageInfo(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Storage resource UUID
$client->storage->modifyStorage($uuid, $request) -> ModifyStorageResponse
Description
Modifies a block storage title, labels, automatic backup rule, or size. A new size must be greater than the current size. Set filesystem_resize to yes to also resize the last partition and its supported filesystem after increasing the block storage size.
Usage
$client->storage->modifyStorage(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new ModifyStorageBody([
'storage' => new ModifyStorageBodyStorage([
'size' => 100,
'title' => 'Production data expanded',
]),
]),
);
Parameters
$uuid: string — Block storage UUID
$storage: ModifyStorageBodyStorage — Block storage properties to modify.
$client->storage->deleteStorage($uuid, $request)
Description
Schedules an unattached private storage resource for deletion. Associated backups are kept by default unless another backup policy is selected.
Usage
$client->storage->deleteStorage(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new DeleteStorageRequest([]),
);
Parameters
$uuid: string — Storage resource UUID
$backups: ?string — Policy for handling backups when deleting a storage resource. Defaults to keep. Allowed values: keep, delete, keep_latest
$client->storage->attachStorageToServer($uuid, $request) -> AttachStorageResponse
Description
Attaches the storage resource to a Cloud Server in the same zone. The device defaults to a disk at the next available address. IDE and CD-ROM devices can be attached only while the Cloud Server is stopped; SCSI and VirtIO disks can also be attached while it is running.
Usage
$client->storage->attachStorageToServer(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new AttachStorageRequest([
'storageDevice' => new AttachStorageRequestStorageDevice([
'server' => '00798b85-efdc-41ca-8021-f6ef457b8531',
'type' => AttachStorageRequestStorageDeviceType::Disk->value,
]),
]),
);
Parameters
$uuid: string — Storage resource UUID
$storageDevice: AttachStorageRequestStorageDevice — Parameters for attaching this storage resource to a Cloud Server in the same zone.
$client->storage->createOnDemandBackup($uuid, $request) -> CreateStorageBackupResponse
Description
Creates a point-in-time backup of private normal block storage. The operation is asynchronous: the source block storage is backuping while the backup is created, and the returned backup remains in maintenance until it is ready.
Usage
$client->storage->createOnDemandBackup(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new CreateStorageBackupRequest([
'storage' => new CreateStorageBackupRequestStorage([
'title' => 'Manually created backup',
]),
]),
);
Parameters
$uuid: string — Block storage UUID
$storage: CreateStorageBackupRequestStorage — Parameters for the point-in-time backup.
$client->storage->cancelStorageOperation($uuid)
Description
Requests cancellation of an interruptible operation on block storage in the maintenance state. For a running clone, cancellation removes the incomplete copy and returns the source block storage to the online state.
Usage
$client->storage->cancelStorageOperation(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Block storage UUID
$client->storage->cloneStorage($uuid, $request) -> CreateStorageResponse
Description
Creates a Block Storage copy of a storage resource. Cloning is asynchronous: the returned block storage remains in the maintenance state until the operation completes and can be monitored with the storage resource details endpoint.
Usage
$client->storage->cloneStorage(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new CloneStorageRequest([
'storage' => new CloneStorageRequestStorage([
'encrypted' => StorageEncrypted::Yes->value,
'tier' => StorageTier::Maxiops->value,
'title' => 'Cloned Block Storage',
'zone' => 'fi-hel1',
]),
]),
);
Parameters
$uuid: string — Storage resource UUID
$storage: CloneStorageRequestStorage — Parameters for the cloned block storage.
$client->storage->detachStorageFromServer($uuid) -> DetachStorageResponse
Description
Detaches the storage resource from its attached Cloud Server. IDE and CD-ROM devices can be detached only while the Cloud Server is stopped; SCSI and VirtIO disks can also be detached while it is running. If the storage resource is already detached, it is returned unchanged.
Usage
$client->storage->detachStorageFromServer(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Storage resource UUID
$client->storage->addStorageToFavorites($uuid)
Description
Adds an accessible storage resource to the account’s favorites. The operation succeeds if the storage resource is already a favorite.
Usage
$client->storage->addStorageToFavorites(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Storage resource UUID
$client->storage->removeStorageFromFavorites($uuid)
Description
Removes an accessible storage resource from the account’s favorites. The operation succeeds if the storage resource is not a favorite.
Usage
$client->storage->removeStorageFromFavorites(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Storage resource UUID
$client->storage->getStorageImportDetails($uuid) -> StorageImportResponse
Description
Returns details of the latest import task for a storage resource, including its state, transferred byte counts, checksums, and any error information.
Usage
$client->storage->getStorageImportDetails(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Storage resource UUID
$client->storage->createStorageImport($uuid, $request) -> StorageImportResponse
Description
Creates an asynchronous task that imports a raw disk image into existing Block Storage from an HTTP URL or a temporary direct-upload URL. Attached Cloud Servers must be stopped.
Usage
$client->storage->createStorageImport(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new CreateStorageImportRequest([
'storageImport' => new CreateStorageImportRequestStorageImport([
'source' => CreateStorageImportRequestStorageImportSource::HttpImport->value,
'sourceLocation' => 'https://example.com/disk.raw',
]),
]),
);
Parameters
$uuid: string — Storage resource UUID
$storageImport: CreateStorageImportRequestStorageImport — Storage import parameters.
$client->storage->cancelStorageImport($uuid) -> StorageImportResponse
Description
Requests cancellation of an ongoing storage import. The task enters the cancelling state while imported data is rolled back when necessary.
Usage
$client->storage->cancelStorageImport(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Storage resource UUID
$client->storage->resizeStorage($uuid) -> ResizeStorageResponse
Description
Resizes the last partition and its supported filesystem to use the block storage capacity already available. A backup is created before the operation and returned on success. Increase the block storage capacity first with the modify block storage endpoint.
Usage
$client->storage->resizeStorage(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Block storage UUID
$client->storage->restoreStorageFromBackup($uuid)
Description
Starts restoring the backup identified by uuid to its origin block storage. If the origin block storage is attached to a Cloud Server, the Cloud Server must be stopped.
Usage
$client->storage->restoreStorageFromBackup(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
);
Parameters
$uuid: string — Backup UUID
$client->storage->createTemplateFromStorage($uuid, $request) -> CreateStorageTemplateResponse
Description
Creates a private template from private normal block storage. The operation is asynchronous: the returned template remains in maintenance until it is ready. Deployments from the template use the source block storage tier.
Usage
$client->storage->createTemplateFromStorage(
'0414e0d7-4436-4037-9dd8-6eaf47dce599',
new CreateStorageTemplateRequest([
'storage' => new CreateStorageTemplateRequestStorage([
'title' => 'My server template',
]),
]),
);
Parameters
$uuid: string — Block storage UUID
$storage: CreateStorageTemplateRequestStorage — Parameters for creating a template from the block storage.
tag
$client->tag->listTags() -> Tags
Description
Returns all existing tags with their properties and servers tagged.
Usage
$client->tag->listTags();
$client->tag->createTag($request) -> Tag
Description
Creates a new tag. Existing servers can be tagged in same request.
Usage
$client->tag->createTag(
new Tag([
'tag' => new TagTag([
'description' => 'Production servers',
'name' => 'PROD',
'servers' => new TagServers([
'server' => [
'0077fa3d-32db-4b09-9f5f-30d9e9afb565',
],
]),
]),
]),
);
Parameters
$request: Tag
$client->tag->getTag($name) -> Tag
Description
Returns details for a specific tag.
Usage
$client->tag->getTag(
'DEV',
);
Parameters
$name: string — Tag name
$client->tag->modifyTag($name, $request) -> Tag
Description
Changes attributes of an existing tag
Usage
$client->tag->modifyTag(
'DEV',
new ModifyTagRequest([
'body' => new Tag([
'tag' => new TagTag([
'description' => 'Production servers',
'name' => 'PROD',
'servers' => new TagServers([
'server' => [
'0077fa3d-32db-4b09-9f5f-30d9e9afb565',
],
]),
]),
]),
]),
);
Parameters
$name: string — Tag name
$request: Tag
$client->tag->deleteTag($name)
Description
Deletes a specific tag.
Usage
$client->tag->deleteTag(
'DEV',
);
Parameters
$name: string — Tag name
timezone
$client->timezone->listTimezones() -> Timezones
Description
Retrieves a list of supported timezones.
Usage
$client->timezone->listTimezones();
account-tokens
$client->accountTokens->listTokens($request) -> array
Description
List all tokens for the currently authorized account. The tokens are returned in a paged format, with the default page size being 20. The maximum page size is 100.
Usage
$client->accountTokens->listTokens(
new ListTokensRequest([
'gui' => true,
'sort' => '+name,-created_at',
]),
);
Parameters
$limit: ?int — How many tokens to return at per page
$offset: ?int — Offset to start listing the tokens from
$gui: ?bool — Filter tokens based on GUI flag (true or false). Default is no value, i.e. no filtering and all tokens are returned.
$sort: ?string — Comma-separated list of fields to sort by. Prefix with ‘+’ for ascending or ‘-‘ for descending order. Supported fields: created_at, expires_at, last_used_at, name. Example: sort=+name,-created_at. If no prefix is given, descending is assumed. Follows OpenAPI collectionFormat ‘csv’.
$client->accountTokens->createToken($request) -> AccountTokensToken
Description
Create a new API token. Maximum token validity is 24*365h=8760h (~1 year). Attribute allowed_ip_prefixes allows defining a list of CIDR/IP addresses from where the token is accepted. Empty list denies access from everywhere. If unset, the default list will be the IP filters of the account. If no IP filters are defined for the account either, the default will be [“0.0.0.0/0”, “::0/0”], i.e. allow from any address.
Usage
$client->accountTokens->createToken(
new AccountTokensCreateTokenRequestExpiresIn([]),
);
Parameters
$request: AccountTokensCreateTokenRequestExpiresIn|AccountTokensCreateTokenRequestExpiresAt
$client->accountTokens->getToken($tokenUuid) -> AccountTokensGetTokenResponse
Description
Get the details of a specific API token.
Usage
$client->accountTokens->getToken(
'token-uuid',
);
Parameters
$tokenUuid: string — The uuid of the token to get
$client->accountTokens->revokeToken($tokenUuid)
Description
Revoke a specific API token.
Usage
$client->accountTokens->revokeToken(
'token-uuid',
);
Parameters
$tokenUuid: string — The uuid of the token to delete
object-storage-2
$client->objectStorage2->listObjectStorages($request) -> array
Description
Returns a list of object storage services.
Usage
$client->objectStorage2->listObjectStorages(
new ListObjectStoragesRequest([
'limit' => 10,
'offset' => 0,
]),
);
Parameters
$limit: ?int — Number of entries to receive at most.
$offset: ?int — Offset for retrieved results.
$sort: ?string — Order of returned results.
$client->objectStorage2->createObjectStorage($request) -> ObjectStorage2ServiceDetailResponse
Description
Creates a new object storage service.
Usage
$client->objectStorage2->createObjectStorage(
new ObjectStorage2ServiceCreate([
'name' => 'example-service',
'region' => 'example',
'configuredStatus' => ObjectStorage2PropertyConfiguredStatus::Started->value,
'networks' => [
new ObjectStorage2NetworkCreate([
'name' => 'example-public-network',
'type' => ObjectStorage2NetworkType::Public_->value,
'family' => ObjectStorage2NetworkFamily::IPv4->value,
]),
new ObjectStorage2NetworkCreate([
'uuid' => '03aa7245-2ff9-49c8-9f0e-7ca0270d71a4',
'name' => 'example-private-network',
'type' => ObjectStorage2NetworkType::Private_->value,
'family' => ObjectStorage2NetworkFamily::IPv4->value,
]),
],
]),
);
Parameters
$name: string
$region: string
$configuredStatus: string
$networks: ?array — Networks to attach to the service. Private networks must reside in the same region as the object storage.
$customDomains: ?array — Custom domains to attach to the service.
$labels: ?array — Labels for classifying the service.
$properties: ?ObjectStorage2PropertiesCreate
$terminationProtection: ?bool — Enables or disables termination protection for the service. When enabled, the service cannot be deleted or powered down unless this is disabled first.
$client->objectStorage2->getObjectStorage($serviceUuid) -> ObjectStorage2ServiceDetailResponse
Description
Returns object storage service details by given {service_uuid}.
Usage
$client->objectStorage2->getObjectStorage(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$client->objectStorage2->replaceObjectStorage($serviceUuid, $request) -> ObjectStorage2ServiceDetailResponse
Description
Replaces existing object storage service by given {service_uuid}.
Usage
$client->objectStorage2->replaceObjectStorage(
'01234567-89ab-cdef-0123-456789abcdef',
new ObjectStorage2ServiceReplace([
'name' => 'example-service',
'configuredStatus' => ObjectStorage2PropertyConfiguredStatus::Started->value,
'networks' => [
new ObjectStorage2NetworkCreate([
'name' => 'example-public-network',
'type' => ObjectStorage2NetworkType::Public_->value,
'family' => ObjectStorage2NetworkFamily::IPv4->value,
]),
new ObjectStorage2NetworkCreate([
'uuid' => '03aa7245-2ff9-49c8-9f0e-7ca0270d71a4',
'name' => 'example-private-network',
'type' => ObjectStorage2NetworkType::Private_->value,
'family' => ObjectStorage2NetworkFamily::IPv4->value,
]),
],
'labels' => [
new ObjectStorage2LabelCreate([
'key' => 'example-label-key',
'value' => 'example-label-value',
]),
],
]),
);
Parameters
$serviceUuid: string — Service UUID
$name: string — The name of the service.
$configuredStatus: string
$terminationProtection: ?bool — Enables or disables termination protection for the service. When enabled, the service cannot be deleted or powered down unless this is disabled first.
$networks: ?array
$customDomains: ?array
$staticWebsites: ?array — Static website configurations for this service. Array replaces all existing configurations.
$labels: ?array
$properties: ?ObjectStorage2PropertiesCreate
$client->objectStorage2->deleteObjectStorage($serviceUuid, $request)
Description
Deletes existing object storage service by given {service_uuid}.
Usage
$client->objectStorage2->deleteObjectStorage(
'01234567-89ab-cdef-0123-456789abcdef',
new DeleteObjectStorageRequest([
'force' => true,
]),
);
Parameters
$serviceUuid: string — Service UUID
$force: ?bool — If the parameter is provided, the deletion process starts even if the service is not empty.
$client->objectStorage2->modifyObjectStorage($serviceUuid, $request) -> ObjectStorage2ServiceDetailResponse
Description
Modifies existing object storage service by given {service_uuid}.
Usage
$client->objectStorage2->modifyObjectStorage(
'01234567-89ab-cdef-0123-456789abcdef',
new ObjectStorage2ServiceModify([
'name' => 'example-service',
'configuredStatus' => ObjectStorage2PropertyConfiguredStatus::Started->value,
'networks' => [
new ObjectStorage2NetworkCreate([
'uuid' => '03aa7245-2ff9-49c8-9f0e-7ca0270d71a4',
'name' => 'example-private-network',
'type' => ObjectStorage2NetworkType::Private_->value,
'family' => ObjectStorage2NetworkFamily::IPv4->value,
]),
],
]),
);
Parameters
$serviceUuid: string — Service UUID
$name: ?string
$configuredStatus: ?string
$networks: ?array
$customDomains: ?array
$staticWebsites: ?array — Static website configurations for this service. Array replaces all existing configurations.
$labels: ?array
$properties: ?ObjectStorage2PropertiesCreate
$terminationProtection: ?bool — Enables or disables termination protection for the service. When enabled, the service cannot be deleted or powered down unless this is disabled first.
$client->objectStorage2->listObjectStorageNetworks($serviceUuid) -> array
Description
Returns a list of available service networks by given {service_uuid}.
Usage
$client->objectStorage2->listObjectStorageNetworks(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$client->objectStorage2->createObjectStorageNetwork($serviceUuid, $request) -> ObjectStorage2NetworkDetailResponse
Description
Creates a new service network by given {service_uuid}.
Usage
$client->objectStorage2->createObjectStorageNetwork(
'01234567-89ab-cdef-0123-456789abcdef',
new CreateObjectStorageNetworkRequest([
'body' => new ObjectStorage2NetworkCreate([
'name' => 'example-public-network',
'type' => ObjectStorage2NetworkType::Public_->value,
'family' => ObjectStorage2NetworkFamily::IPv4->value,
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$request: ObjectStorage2NetworkCreate
$client->objectStorage2->getObjectStorageNetwork($serviceUuid, $networkName) -> ObjectStorage2NetworkDetailResponse
Description
Returns service network details by given {service_uuid} and {network_name}.
Usage
$client->objectStorage2->getObjectStorageNetwork(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$networkName: string — The name of the network.
$client->objectStorage2->deleteObjectStorageNetwork($serviceUuid, $networkName)
Description
Deletes existing network by given {service_uuid} and {network_name}.
Usage
$client->objectStorage2->deleteObjectStorageNetwork(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$networkName: string — The name of the network.
$client->objectStorage2->listObjectStorageCustomDomains($serviceUuid) -> array
Description
Returns a list of custom domains attached to a service by given {service_uuid}.
Usage
$client->objectStorage2->listObjectStorageCustomDomains(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$client->objectStorage2->attachObjectStorageCustomDomain($serviceUuid, $request) -> ObjectStorage2CustomDomainDetailResponse
Description
Attaches a new custom domain to the service identified by {service_uuid}.
Usage
$client->objectStorage2->attachObjectStorageCustomDomain(
'01234567-89ab-cdef-0123-456789abcdef',
new AttachObjectStorageCustomDomainRequest([
'body' => new ObjectStorage2CustomDomainCreate([
'type' => ObjectStorage2CustomDomainCreateType::Public_->value,
'domainName' => 'example.com',
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$request: ObjectStorage2CustomDomainCreate
$client->objectStorage2->getObjectStorageCustomDomain($serviceUuid, $customDomainName) -> ObjectStorage2CustomDomainDetailResponse
Description
Returns custom domain details by given {service_uuid} and {domain_name}.
Usage
$client->objectStorage2->getObjectStorageCustomDomain(
'01234567-89ab-cdef-0123-456789abcdef',
'example.com',
);
Parameters
$serviceUuid: string — Service UUID
$customDomainName: string — The domain name.
$client->objectStorage2->deleteObjectStorageCustomDomain($serviceUuid, $customDomainName)
Description
Deletes existing custom domain by given {service_uuid} and {domain_name}.
Usage
$client->objectStorage2->deleteObjectStorageCustomDomain(
'01234567-89ab-cdef-0123-456789abcdef',
'example.com',
);
Parameters
$serviceUuid: string — Service UUID
$customDomainName: string — The domain name.
$client->objectStorage2->modifyObjectStorageCustomDomain($serviceUuid, $customDomainName, $request) -> ObjectStorage2CustomDomainDetailResponse
Description
Modifies existing custom domain by given {service_uuid} and {domain_name}.
Usage
$client->objectStorage2->modifyObjectStorageCustomDomain(
'01234567-89ab-cdef-0123-456789abcdef',
'example.com',
new ObjectStorage2CustomDomainModify([
'type' => ObjectStorage2CustomDomainModifyType::Public_->value,
'domainName' => 'example.com',
]),
);
Parameters
$serviceUuid: string — Service UUID
$customDomainName: string — The domain name.
$type: ?string — Type of the custom domain.
$domainName: ?string — New modified custom domain. Supports both apex domains (example.com) and subdomains (objects.example.com).
$client->objectStorage2->listObjectStorageRegions() -> array
Description
Returns a list of available managed object storage regions.
Usage
$client->objectStorage2->listObjectStorageRegions();
$client->objectStorage2->getObjectStorageRegion($regionName) -> ObjectStorage2RegionDetailResponse
Description
Returns object storage region details by given {name}.
Usage
$client->objectStorage2->getObjectStorageRegion(
'my-object-storage',
);
Parameters
$regionName: string — The name of the region.
$client->objectStorage2->getObjectStorageMetrics($serviceUuid) -> ObjectStorage2MetricsUsageResponse
Description
Returns object storage metrics by given {service_uuid}.
Usage
$client->objectStorage2->getObjectStorageMetrics(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$client->objectStorage2->listObjectStorageBucketMetrics($serviceUuid, $request) -> array
Description
Returns metrics for buckets within a service.
Usage
$client->objectStorage2->listObjectStorageBucketMetrics(
'01234567-89ab-cdef-0123-456789abcdef',
new ListObjectStorageBucketMetricsRequest([
'limit' => 10,
'offset' => 0,
]),
);
Parameters
$serviceUuid: string — Service UUID
$limit: ?int — Number of entries to receive at most.
$offset: ?int — Offset for retrieved results.
$client->objectStorage2->createObjectStorageBucket($serviceUuid, $request) -> ObjectStorage2BucketDetailResponse
Description
Creates a new service bucket by the given {service_uuid}.
Usage
$client->objectStorage2->createObjectStorageBucket(
'01234567-89ab-cdef-0123-456789abcdef',
new ObjectStorage2BucketCreate([
'name' => 'my-bucket-1',
]),
);
Parameters
$serviceUuid: string — Service UUID
$name: string — Must be unique within the service, and should contain only alphanumeric, .,- and _.
$client->objectStorage2->deleteObjectStorageBucket($serviceUuid, $bucketName)
Description
Deletes an existing bucket by given {service_uuid} and {bucket_name}. This API call will remove all objects from the bucket permanently and cannot be reversed.
Usage
$client->objectStorage2->deleteObjectStorageBucket(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$bucketName: string — The name of the bucket.
$client->objectStorage2->listObjectStorageMetricsSeries($serviceUuid, $request) -> array
Description
Returns Object Storage instance metrics series by a given {service_uuid}.
Usage
$client->objectStorage2->listObjectStorageMetricsSeries(
'01234567-89ab-cdef-0123-456789abcdef',
new ListObjectStorageMetricsSeriesRequest([
'from' => new DateTime('2024-01-01T00:00:00Z'),
'to' => new DateTime('2024-01-01T00:00:00Z'),
'interval' => '1h',
'limit' => 10,
'offset' => 0,
]),
);
Parameters
$serviceUuid: string — Service UUID
$from: ?DateTime — Beginning of the time range for which to return metrics.
$to: ?DateTime — End of the time range for which to return metrics.
$interval: ?string — Metrics aggregation interval.
$sort: ?string — Order of returned results.
$limit: ?int — Number of entries to receive at most.
$offset: ?int — Offset for retrieved results.
$client->objectStorage2->listObjectStorageLabels($serviceUuid) -> array
Description
Returns a list of available service labels by given {service_uuid}.
Usage
$client->objectStorage2->listObjectStorageLabels(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$client->objectStorage2->createObjectStorageLabel($serviceUuid, $request) -> ObjectStorage2LabelDetailResponse
Description
Creates a new label by given {service_uuid}. Labels are used for service filtering.
Usage
$client->objectStorage2->createObjectStorageLabel(
'01234567-89ab-cdef-0123-456789abcdef',
new CreateObjectStorageLabelRequest([
'body' => new ObjectStorage2LabelCreate([
'key' => 'foo',
'value' => 'bar',
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$request: ObjectStorage2LabelCreate
$client->objectStorage2->getObjectStorageLabel($serviceUuid, $labelKey) -> ObjectStorage2LabelDetailResponse
Description
Returns label details by given {service_uuid} and {key}.
Usage
$client->objectStorage2->getObjectStorageLabel(
'01234567-89ab-cdef-0123-456789abcdef',
'environment',
);
Parameters
$serviceUuid: string — Service UUID
$labelKey: string — The key of the label.
$client->objectStorage2->deleteObjectStorageLabel($serviceUuid, $labelKey)
Description
Deletes existing label by given {service_uuid} and {key}.
Usage
$client->objectStorage2->deleteObjectStorageLabel(
'01234567-89ab-cdef-0123-456789abcdef',
'environment',
);
Parameters
$serviceUuid: string — Service UUID
$labelKey: string — The key of the label.
$client->objectStorage2->modifyObjectStorageLabel($serviceUuid, $labelKey, $request) -> ObjectStorage2LabelDetailResponse
Description
Modifies existing label by given {service_uuid} and {key}.
Usage
$client->objectStorage2->modifyObjectStorageLabel(
'01234567-89ab-cdef-0123-456789abcdef',
'environment',
new ObjectStorage2LabelModify([
'key' => 'foo',
'value' => 'bar',
]),
);
Parameters
$serviceUuid: string — Service UUID
$labelKey: string — The key of the label.
$key: ?string
$value: ?string
$client->objectStorage2->listObjectStorageStaticWebsites($serviceUuid)
Description
Returns all static website configurations for a service along with available domains.
Usage
$client->objectStorage2->listObjectStorageStaticWebsites(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$client->objectStorage2->createObjectStorageStaticWebsite($serviceUuid, $request) -> ObjectStorage2StaticWebsiteConfig
Description
Creates a new static website hosting configuration for a domain.
Usage
$client->objectStorage2->createObjectStorageStaticWebsite(
'01234567-89ab-cdef-0123-456789abcdef',
new CreateObjectStorageStaticWebsiteRequest([
'body' => new ObjectStorage2StaticWebsiteConfigCreate([
'bucketName' => 'my-website',
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$request: ObjectStorage2StaticWebsiteConfigCreate
$client->objectStorage2->getObjectStorageStaticWebsite($serviceUuid, $customDomainName) -> ObjectStorage2StaticWebsiteConfig
Description
Returns a static website configuration for a specific domain.
Usage
$client->objectStorage2->getObjectStorageStaticWebsite(
'01234567-89ab-cdef-0123-456789abcdef',
'example.com',
);
Parameters
$serviceUuid: string — Service UUID
$customDomainName: string — The domain name.
$client->objectStorage2->deleteObjectStorageStaticWebsite($serviceUuid, $customDomainName)
Description
Deletes a static website configuration.
Usage
$client->objectStorage2->deleteObjectStorageStaticWebsite(
'01234567-89ab-cdef-0123-456789abcdef',
'example.com',
);
Parameters
$serviceUuid: string — Service UUID
$customDomainName: string — The domain name.
$client->objectStorage2->modifyObjectStorageStaticWebsite($serviceUuid, $customDomainName, $request) -> ObjectStorage2StaticWebsiteConfig
Description
Updates an existing static website configuration.
Usage
$client->objectStorage2->modifyObjectStorageStaticWebsite(
'01234567-89ab-cdef-0123-456789abcdef',
'example.com',
new ObjectStorage2StaticWebsiteConfigModify([]),
);
Parameters
$serviceUuid: string — Service UUID
$customDomainName: string — The domain name.
$bucketName: ?string — Name of the S3/ECS bucket containing the website content. Only alphanumerics, dots, hyphens, and underscores are allowed.
$bucketPrefix: ?string — Optional prefix/subfolder within the bucket. Only alphanumerics, slashes, dots, hyphens, and underscores are allowed.
$indexDocument: ?string — Default document for directories. Only alphanumerics, slashes, dots, hyphens, and underscores are allowed.
$spaMode: ?bool — Enable Single Page Application (SPA) mode. When enabled, all non-file routes serve the index document, allowing client-side routing to handle the URL. Essential for React, Vue, Next.js, and similar frameworks.
$enabled: ?bool — Whether the static website configuration should be active
$errorPages: ?array — Custom error page configurations for specific HTTP status codes or ranges. Replaces the entire set when provided.
$client->objectStorage2->listObjectStorageDomains($serviceUuid) -> ObjectStorage2ServiceDomains
Description
Returns all domains associated with this service (public endpoint, private endpoint, custom domains) along with their static website hosting status.
Usage
$client->objectStorage2->listObjectStorageDomains(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$client->objectStorage2->listObjectStorageUsers($serviceUuid) -> array
Description
Returns a list of available service users by given {service_uuid}.
Usage
$client->objectStorage2->listObjectStorageUsers(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$client->objectStorage2->createObjectStorageUser($serviceUuid, $request) -> ObjectStorage2UserDetailResponse
Description
Creates a new service user by given {service_uuid}.
Usage
$client->objectStorage2->createObjectStorageUser(
'01234567-89ab-cdef-0123-456789abcdef',
new ObjectStorage2UserCreate([
'username' => 'example_user',
]),
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user to create.
$client->objectStorage2->getObjectStorageUser($serviceUuid, $username) -> ObjectStorage2UserDetailResponse
Description
Returns service user details by given {service_uuid} and {username}.
Usage
$client->objectStorage2->getObjectStorageUser(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$client->objectStorage2->deleteObjectStorageUser($serviceUuid, $username)
Description
Deletes existing user by given {service_uuid} and {username}.
Usage
$client->objectStorage2->deleteObjectStorageUser(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$client->objectStorage2->listObjectStorageAccessKeys($serviceUuid, $username) -> array
Description
Returns a list of available access keys for a user.
Usage
$client->objectStorage2->listObjectStorageAccessKeys(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$client->objectStorage2->createObjectStorageAccessKey($serviceUuid, $username) -> ObjectStorage2CreateAccessKeyResponse
Description
Creates a new access key by given {service_uuid} and {username}.
Usage
$client->objectStorage2->createObjectStorageAccessKey(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$client->objectStorage2->getObjectStorageAccessKeyDetails($serviceUuid, $username, $accessKeyId) -> ObjectStorage2AccessKeyDetailResponse
Description
Returns access key details by given {service_uuid}, {username}, and {access-key-id}.
Usage
$client->objectStorage2->getObjectStorageAccessKeyDetails(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
'UCK1234567890ABCDEF',
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$accessKeyId: string — The ID of the access key.
$client->objectStorage2->deleteObjectStorageAccessKey($serviceUuid, $username, $accessKeyId)
Description
Deletes existing access key by given {service_uuid}, {username}, and {access-key-id}.
Usage
$client->objectStorage2->deleteObjectStorageAccessKey(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
'UCK1234567890ABCDEF',
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$accessKeyId: string — The ID of the access key.
$client->objectStorage2->modifyObjectStorageAccessKeyDetails($serviceUuid, $username, $accessKeyId, $request) -> ObjectStorage2AccessKeyDetailResponse
Description
Modifies access key details.
Usage
$client->objectStorage2->modifyObjectStorageAccessKeyDetails(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
'UCK1234567890ABCDEF',
new ObjectStorage2AccessKeyModify([
'status' => ObjectStorage2AccessKeyModifyStatus::Inactive->value,
]),
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$accessKeyId: string — The ID of the access key.
$status: ?string — Indicates if the key is active or inactive.
$client->objectStorage2->listObjectStorageAttachedUserPolicies($serviceUuid, $username) -> array
Description
Returns a list of attached user policies for a user.
Usage
$client->objectStorage2->listObjectStorageAttachedUserPolicies(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$client->objectStorage2->attachObjectStorageUserPolicy($serviceUuid, $username, $request)
Description
Attach a policy to a user.
Usage
$client->objectStorage2->attachObjectStorageUserPolicy(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
new AttachObjectStorageUserPolicyRequest([
'body' => new ObjectStorage2PolicyAttachmentCreate([
'name' => 'test-policy',
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$request: ObjectStorage2PolicyAttachmentCreate
$client->objectStorage2->detachObjectStorageUserPolicy($serviceUuid, $username, $nestedName)
Description
Detach a policy from a user.
Usage
$client->objectStorage2->detachObjectStorageUserPolicy(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$nestedName: string — The name of the policy to detach.
$client->objectStorage2->getObjectStorageUserInlinePolicy($serviceUuid, $username, $userPolicyName) -> ObjectStorage2InlinePolicyResponse
Description
Get the user inline policy by the given {service_uuid}, {username} and {policy_name}.
Usage
$client->objectStorage2->getObjectStorageUserInlinePolicy(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$userPolicyName: string — The name of the inline policy.
$client->objectStorage2->deleteObjectStorageUserInlinePolicy($serviceUuid, $username, $userPolicyName)
Description
Deletes the user inline policy by the given {service_uuid}, {username}, and {policy_name}.
Usage
$client->objectStorage2->deleteObjectStorageUserInlinePolicy(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$userPolicyName: string — The name of the inline policy.
$client->objectStorage2->listObjectStorageUserInlinePolicies($serviceUuid, $username) -> array
Description
Lists the user inline policies by the given {service_uuid}, and {username}.
Usage
$client->objectStorage2->listObjectStorageUserInlinePolicies(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$client->objectStorage2->createObjectStorageUserInlinePolicy($serviceUuid, $username, $request) -> ObjectStorage2InlinePolicyResponse
Description
Creates a user inline policy by the given {service_uuid}, and {username}.
Usage
$client->objectStorage2->createObjectStorageUserInlinePolicy(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
new CreateObjectStorageUserInlinePolicyRequest([
'body' => new ObjectStorage2InlinePolicyCreate([
'name' => 'ECSS3FullAccess',
'document' => '{"Version":"2012-10-17","Statement":[{"Action":"sts:AssumeRole","Effect":"Allow","Resource":"*"}]}',
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$request: ObjectStorage2InlinePolicyCreate
$client->objectStorage2->getObjectStorageUserTags($serviceUuid, $username) -> array
Description
Returns a user’s tags by the given {service_uuid}, and {username}.
Usage
$client->objectStorage2->getObjectStorageUserTags(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$client->objectStorage2->replaceObjectStorageUserTags($serviceUuid, $username, $request) -> array
Description
Replaces a user’s tags by the given {service_uuid}, and {username}.
Usage
$client->objectStorage2->replaceObjectStorageUserTags(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
new ReplaceObjectStorageUserTagsRequest([
'body' => [
new ObjectStorage2TagListRequestItem([
'key' => 'environment',
'value' => 'production',
]),
new ObjectStorage2TagListRequestItem([
'key' => 'team',
'value' => 'backend',
]),
],
]),
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$request: array
$client->objectStorage2->deleteObjectStorageUserTag($serviceUuid, $username, $userTagKey)
Description
Deletes a user’s tag by the given {service_uuid}, {username}, and {tag_key}.
Usage
$client->objectStorage2->deleteObjectStorageUserTag(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
'environment',
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$userTagKey: string — The key of the user tag.
$client->objectStorage2->createObjectStorageUserPermissionsBoundary($serviceUuid, $username, $request) -> string
Description
Creates a user’s permissions boundary by the given {service_uuid}, and {username}.
Usage
$client->objectStorage2->createObjectStorageUserPermissionsBoundary(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
new CreateObjectStorageUserPermissionsBoundaryRequest([
'body' => new ObjectStorage2PermissionsBoundaryCreate([
'policyName' => 'sample-policy',
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$request: ObjectStorage2PermissionsBoundaryCreate
$client->objectStorage2->deleteObjectStorageUserPermissionsBoundary($serviceUuid, $username)
Description
Deletes a user’s permissions boundary by the given {service_uuid}, and {username}.
Usage
$client->objectStorage2->deleteObjectStorageUserPermissionsBoundary(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$username: string — The name of the user.
$client->objectStorage2->listObjectStoragePolicyVersions($serviceUuid, $policyName) -> array
Description
Lists policy versions given by {service_uuid}, and {policy_name}.
Usage
$client->objectStorage2->listObjectStoragePolicyVersions(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$policyName: string — The name of the policy.
$client->objectStorage2->createObjectStoragePolicyVersion($serviceUuid, $policyName, $request) -> ObjectStorage2PolicyVersionResponse
Description
Creates a policy version by the given {service_uuid}, and {policy_name}.
Usage
$client->objectStorage2->createObjectStoragePolicyVersion(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
new ObjectStorage2PolicyVersionCreate([
'document' => '{"Version":"2012-10-17","Statement":[{"Action":["*"],"Effect":"Deny","Resource":"*"}]}',
'isDefault' => true,
]),
);
Parameters
$serviceUuid: string — Service UUID
$policyName: string — The name of the policy.
$document: string — A valid, URL-encoded policy document.
$isDefault: bool — Set this version as the default.
$client->objectStorage2->getObjectStoragePolicyVersion($serviceUuid, $policyName, $policyVersion) -> ObjectStorage2PolicyVersionResponse
Description
Get a single policy version by the given {service_uuid}, {policy_name}, and {policy_version}.
Usage
$client->objectStorage2->getObjectStoragePolicyVersion(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
'v1',
);
Parameters
$serviceUuid: string — Service UUID
$policyName: string — The name of the policy.
$policyVersion: string — The version identifier of the policy.
$client->objectStorage2->deleteObjectStoragePolicyVersion($serviceUuid, $policyName, $policyVersion)
Description
Deletes a policy version by the given {service_uuid}, {policy_name}, and {policy_version}.
Usage
$client->objectStorage2->deleteObjectStoragePolicyVersion(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
'v1',
);
Parameters
$serviceUuid: string — Service UUID
$policyName: string — The name of the policy.
$policyVersion: string — The version identifier of the policy.
$client->objectStorage2->getObjectStoragePolicy($serviceUuid, $policyName) -> ObjectStorage2PolicyDetailResponse
Description
Returns service policy details by given {service_uuid} and {policy_name}.
Usage
$client->objectStorage2->getObjectStoragePolicy(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$policyName: string — The name of the policy.
$client->objectStorage2->deleteObjectStoragePolicy($serviceUuid, $policyName)
Description
Deletes existing policy by given {service_uuid} and {policy_name}.
Usage
$client->objectStorage2->deleteObjectStoragePolicy(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$policyName: string — The name of the policy.
$client->objectStorage2->setObjectStorageDefaultPolicyVersion($serviceUuid, $policyName, $request) -> ObjectStorage2PolicyDetailResponse
Description
Sets the default version for a policy. Note: This is mapped from ModifyPolicyVersion handler.
Usage
$client->objectStorage2->setObjectStorageDefaultPolicyVersion(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
new ObjectStorage2PolicySetDefaultVersion([
'versionId' => 'v2',
]),
);
Parameters
$serviceUuid: string — Service UUID
$policyName: string — The name of the policy.
$versionId: string — The policy version ID to set as default.
$client->objectStorage2->listObjectStoragePolicies($serviceUuid) -> array
Description
Returns a list of available service policies by given {service_uuid}.
Usage
$client->objectStorage2->listObjectStoragePolicies(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$client->objectStorage2->createObjectStoragePolicy($serviceUuid, $request) -> ObjectStorage2PolicyDetailResponse
Description
Creates a new service policy by given {service_uuid}.
Usage
$client->objectStorage2->createObjectStoragePolicy(
'01234567-89ab-cdef-0123-456789abcdef',
new ObjectStorage2PolicyCreate([
'name' => 'example-policy',
'description' => 'example-description',
'document' => '%7B%22Version%22%3A%20%222012-10-17%22%2C%20%20%22Statement%22%3A%20%5B%7B%22Action%22%3A%20%5B%22iam%3AGetUser%22%5D%2C%20%22Resource%22%3A%20%22%2A%22%2C%20%22Effect%22%3A%20%22Allow%22%2C%20%22Sid%22%3A%20%22editor%22%7D%5D%7D',
]),
);
Parameters
$serviceUuid: string — Service UUID
$name: string — Unique name of the policy.
$description: ?string — The policy description.
$document: string — A valid, URL-encoded policy document.
$client->objectStorage2->listObjectStorageIamGroupPolicies($serviceUuid, $groupName) -> array
Description
Lists IAM policies attached to a group.
Usage
$client->objectStorage2->listObjectStorageIamGroupPolicies(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$groupName: string — The name of the group.
$client->objectStorage2->attachObjectStorageIamGroupPolicy($serviceUuid, $groupName, $request)
Description
Attaches a policy to a group.
Usage
$client->objectStorage2->attachObjectStorageIamGroupPolicy(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
new AttachObjectStorageIamGroupPolicyRequest([
'body' => new ObjectStorage2PolicyAttachmentCreate([
'name' => 'test-policy',
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$groupName: string — The name of the group.
$request: ObjectStorage2PolicyAttachmentCreate
$client->objectStorage2->detachObjectStorageIamGroupPolicy($serviceUuid, $groupName, $policyName)
Description
Detaches a policy from a group.
Usage
$client->objectStorage2->detachObjectStorageIamGroupPolicy(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$groupName: string — The name of the group.
$policyName: string — The name of the policy.
$client->objectStorage2->listObjectStorageGroups($serviceUuid) -> array
Description
Returns a list of available service groups by given {service_uuid}.
Usage
$client->objectStorage2->listObjectStorageGroups(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$client->objectStorage2->createObjectStorageGroup($serviceUuid, $request) -> ObjectStorage2GroupResponse
Description
Creates an iam group.
Usage
$client->objectStorage2->createObjectStorageGroup(
'01234567-89ab-cdef-0123-456789abcdef',
new ObjectStorage2GroupCreate([
'name' => 'new-group',
]),
);
Parameters
$serviceUuid: string — Service UUID
$name: string — A valid string to represent the name of the IAM group.
$client->objectStorage2->getObjectStorageGroup($serviceUuid, $groupName) -> ObjectStorage2GroupResponse
Description
Get a single group identified by {service_uuid}, and {group_name}.
Usage
$client->objectStorage2->getObjectStorageGroup(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$groupName: string — The name of the group.
$client->objectStorage2->deleteObjectStorageGroup($serviceUuid, $groupName)
Description
Deletes a group identified by {group_name}.
Usage
$client->objectStorage2->deleteObjectStorageGroup(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$groupName: string — The name of the group.
$client->objectStorage2->attachObjectStorageUserToGroup($serviceUuid, $groupName, $username)
Description
Attaches an iam user to a group identified by {group_name}, and {username}.
Usage
$client->objectStorage2->attachObjectStorageUserToGroup(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$groupName: string — The name of the group.
$username: string — The name of the user.
$client->objectStorage2->removeObjectStorageUserFromGroup($serviceUuid, $groupName, $username)
Description
Removes an iam user from the group identified by {group_name}, and {username}.
Usage
$client->objectStorage2->removeObjectStorageUserFromGroup(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$groupName: string — The name of the group.
$username: string — The name of the user.
$client->objectStorage2->listObjectStorageGroupInlinePolicies($serviceUuid, $groupName) -> array
Description
Lists the group inline policies by the given {service_uuid}, and {group_name}.
Usage
$client->objectStorage2->listObjectStorageGroupInlinePolicies(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$groupName: string — The name of the group.
$client->objectStorage2->createObjectStorageGroupInlinePolicy($serviceUuid, $groupName, $request) -> ObjectStorage2InlinePolicyResponse
Description
Creates a group inline policy by the given {service_uuid}, and {group_name}.
Usage
$client->objectStorage2->createObjectStorageGroupInlinePolicy(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
new CreateObjectStorageGroupInlinePolicyRequest([
'body' => new ObjectStorage2InlinePolicyCreate([
'name' => 'ECSS3FullAccess',
'document' => '{"Version":"2012-10-17","Statement":[{"Action":"sts:AssumeRole","Effect":"Allow","Resource":"*"}]}',
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$groupName: string — The name of the group.
$request: ObjectStorage2InlinePolicyCreate
$client->objectStorage2->getObjectStorageGroupInlinePolicy($serviceUuid, $groupName, $groupPolicyName) -> ObjectStorage2InlinePolicyResponse
Description
Get the group inline policy by the given {service_uuid}, {group_name} and {policy_name}.
Usage
$client->objectStorage2->getObjectStorageGroupInlinePolicy(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$groupName: string — The name of the group.
$groupPolicyName: string — The name of the inline policy.
$client->objectStorage2->deleteObjectStorageGroupInlinePolicy($serviceUuid, $groupName, $groupPolicyName)
Description
Deletes the group inline policy by the given {service_uuid}, {group_name}, and {policy_name}.
Usage
$client->objectStorage2->deleteObjectStorageGroupInlinePolicy(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$groupName: string — The name of the group.
$groupPolicyName: string — The name of the inline policy.
$client->objectStorage2->listObjectStorageRoles($serviceUuid) -> array
Description
Lists the roles.
Usage
$client->objectStorage2->listObjectStorageRoles(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$client->objectStorage2->createObjectStorageRole($serviceUuid, $request) -> ObjectStorage2RoleResponse
Description
Creates a service IAM role.
Usage
$client->objectStorage2->createObjectStorageRole(
'01234567-89ab-cdef-0123-456789abcdef',
new ObjectStorage2RoleCreate([
'name' => 'test-role',
'assumeRolePolicyDocument' => '{"Version": "2012-10-17","Statement": [{"Action": "sts:AssumeRole","Principal": {"AWS": ["urn:ecs:iam::ns1:user/Demby"]},"Effect": "Allow","Resource": "*"}]}',
'description' => 'A test role.',
'maxSessionDuration' => 3600,
'permissionsBoundary' => 'test-policy',
'tags' => [
new ObjectStorage2RoleTag([
'key' => 'department',
'value' => 'Finance',
]),
new ObjectStorage2RoleTag([
'key' => 'school',
'value' => 'University of Helsinki',
]),
],
]),
);
Parameters
$serviceUuid: string — Service UUID
$name: string
$assumeRolePolicyDocument: string — The policy document that grants an entity permission to assume the role.
$description: ?string — Description of the role.
$maxSessionDuration: ?int — Maximum session duration in seconds.
$permissionsBoundary: ?string — Policy name to set as the permissions boundary.
$tags: ?array — Tags to attach to the role (max 50).
$client->objectStorage2->getObjectStorageRole($serviceUuid, $roleName) -> ObjectStorage2RoleResponse
Description
Get a single role identified by {service_uuid}, and {role_name}.
Usage
$client->objectStorage2->getObjectStorageRole(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$roleName: string — The name of the role.
$client->objectStorage2->deleteObjectStorageRole($serviceUuid, $roleName)
Description
Deletes a service’s IAM role.
Usage
$client->objectStorage2->deleteObjectStorageRole(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$roleName: string — The name of the role.
$client->objectStorage2->updateObjectStorageRole($serviceUuid, $roleName, $request) -> ObjectStorage2RoleResponse
Description
Updates a service’s IAM role.
Usage
$client->objectStorage2->updateObjectStorageRole(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
new ObjectStorage2RoleUpdate([
'description' => 'New description',
'maxSessionDuration' => 3900,
]),
);
Parameters
$serviceUuid: string — Service UUID
$roleName: string — The name of the role.
$description: ?string — New description for the role.
$maxSessionDuration: ?int — New maximum session duration in seconds.
$client->objectStorage2->listObjectStorageRoleInlinePolicies($serviceUuid, $roleName) -> array
Description
Returns a list of role inline policies by the given {service_uuid}, and {role_name}.
Usage
$client->objectStorage2->listObjectStorageRoleInlinePolicies(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$roleName: string — The name of the role.
$client->objectStorage2->createObjectStorageRoleInlinePolicy($serviceUuid, $roleName, $request) -> ObjectStorage2InlinePolicyResponse
Description
Creates a role inline policy by the given {service_uuid}, and {role_name}.
Usage
$client->objectStorage2->createObjectStorageRoleInlinePolicy(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
new CreateObjectStorageRoleInlinePolicyRequest([
'body' => new ObjectStorage2InlinePolicyCreate([
'name' => 'ECSS3FullAccess',
'document' => '{"Version":"2012-10-17","Statement":[{"Action":"sts:AssumeRole","Effect":"Allow","Resource":"*"}]}',
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$roleName: string — The name of the role.
$request: ObjectStorage2InlinePolicyCreate
$client->objectStorage2->getObjectStorageRoleInlinePolicy($serviceUuid, $roleName, $rolePolicyName) -> ObjectStorage2InlinePolicyResponse
Description
Returns a role’s inline policy by the given {service_uuid}, {role_name}, and {policy_name}.
Usage
$client->objectStorage2->getObjectStorageRoleInlinePolicy(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$roleName: string — The name of the role.
$rolePolicyName: string — The name of the inline policy.
$client->objectStorage2->deleteObjectStorageRoleInlinePolicy($serviceUuid, $roleName, $rolePolicyName)
Description
Delete a role inline policy by the given {service_uuid}, {role_name} and {policy_name}.
Usage
$client->objectStorage2->deleteObjectStorageRoleInlinePolicy(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$roleName: string — The name of the role.
$rolePolicyName: string — The name of the inline policy.
$client->objectStorage2->createObjectStorageRolePermissionsBoundary($serviceUuid, $roleName, $request) -> string
Description
Creates a role policy’s permissions boundary by the given {service_uuid}, and {role_name}.
Usage
$client->objectStorage2->createObjectStorageRolePermissionsBoundary(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
new CreateObjectStorageRolePermissionsBoundaryRequest([
'body' => new ObjectStorage2PermissionsBoundaryCreate([
'policyName' => 'sample-policy',
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$roleName: string — The name of the role.
$request: ObjectStorage2PermissionsBoundaryCreate
$client->objectStorage2->deleteObjectStorageRolePermissionsBoundary($serviceUuid, $roleName)
Description
Deletes a role permissions boundary by the given {service_uuid}, and {role_name}.
Usage
$client->objectStorage2->deleteObjectStorageRolePermissionsBoundary(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$roleName: string — The name of the role.
$client->objectStorage2->assumeObjectStorageRolePolicy($serviceUuid, $roleName, $request) -> ObjectStorage2AssumeRolePolicyResponse
Description
Assume a role policy by the given {service_uuid}, and {role_name}.
Usage
$client->objectStorage2->assumeObjectStorageRolePolicy(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
new ObjectStorage2AssumeRolePolicyRequest([
'document' => '{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal":{"Service":"backup.upcloud.com"},"Action":"sts:AssumeRole"}]}',
]),
);
Parameters
$serviceUuid: string — Service UUID
$roleName: string — The name of the role.
$document: string — The assume role policy document that grants an entity permission to assume the role.
$client->objectStorage2->listObjectStorageAttachedRolePolicies($serviceUuid, $roleName) -> array
Description
Lists all policies attached to a service’s IAM role.
Usage
$client->objectStorage2->listObjectStorageAttachedRolePolicies(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$roleName: string — The name of the role.
$client->objectStorage2->attachObjectStoragePolicyToRole($serviceUuid, $roleName, $request)
Description
Attaches a policy to a service’s IAM role.
Usage
$client->objectStorage2->attachObjectStoragePolicyToRole(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
new AttachObjectStoragePolicyToRoleRequest([
'body' => new ObjectStorage2PolicyAttachmentCreate([
'name' => 'test-policy',
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$roleName: string — The name of the role.
$request: ObjectStorage2PolicyAttachmentCreate
$client->objectStorage2->detachObjectStoragePolicyFromRole($serviceUuid, $roleName, $rolePolicyName)
Description
Detaches a policy from a service’s IAM role.
Usage
$client->objectStorage2->detachObjectStoragePolicyFromRole(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$roleName: string — The name of the role.
$rolePolicyName: string — The name of the inline policy.
$client->objectStorage2->getObjectStorageRoleTags($serviceUuid, $roleName) -> array
Description
Returns a role’s tags by the given {service_uuid}, and {role_name}.
Usage
$client->objectStorage2->getObjectStorageRoleTags(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
);
Parameters
$serviceUuid: string — Service UUID
$roleName: string — The name of the role.
$client->objectStorage2->replaceObjectStorageRoleTags($serviceUuid, $roleName, $request) -> array
Description
Replaces a role’s tags by the given {service_uuid}, and {role_name}.
Usage
$client->objectStorage2->replaceObjectStorageRoleTags(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
new ReplaceObjectStorageRoleTagsRequest([
'body' => [
new ObjectStorage2TagListRequestItem([
'key' => 'environment',
'value' => 'production',
]),
new ObjectStorage2TagListRequestItem([
'key' => 'team',
'value' => 'backend',
]),
],
]),
);
Parameters
$serviceUuid: string — Service UUID
$roleName: string — The name of the role.
$request: array
$client->objectStorage2->deleteObjectStorageRoleTag($serviceUuid, $roleName, $roleTagKey)
Description
Deletes a role’s tag by the given {service_uuid}, {role_name}, and {tag_key}.
Usage
$client->objectStorage2->deleteObjectStorageRoleTag(
'01234567-89ab-cdef-0123-456789abcdef',
'my-object-storage',
'environment',
);
Parameters
$serviceUuid: string — Service UUID
$roleName: string — The name of the role.
$roleTagKey: string — The key of the role tag.
file-storage
$client->fileStorage->listFileStorages($request) -> array
Description
Returns a list of File Storage services.
Usage
$client->fileStorage->listFileStorages(
new ListFileStoragesRequest([]),
);
Parameters
$limit: ?int — Number of entries to receive at most.
$offset: ?int — Offset for retrieved results.
$sort: ?string — Order of returned results.
$client->fileStorage->createFileStorage($request) -> FileStorageServiceDetailResponse
Description
Creates a new File Storage service.
Usage
$client->fileStorage->createFileStorage(
new FileStorageServiceCreate([
'name' => 'test-name',
'zone' => 'fi-hel2',
'configuredStatus' => FileStorageConfiguredStatus::Started->value,
'sizeGib' => 250,
'encrypted' => false,
'networks' => [
new FileStorageNetworkCreate([
'uuid' => '03720d07-80a9-41ac-90b0-68a932109339',
'name' => 'net',
'family' => FileStorageNetworkFamily::IPv4->value,
'ipAddress' => '192.168.147.120',
]),
],
'shares' => [
new FileStorageShareCreate([
'name' => 'read',
'path' => '/public',
'acl' => [
new FileStorageAclCreate([
'name' => 'test-name',
'target' => '*',
'permission' => FileStoragePermission::Ro->value,
]),
],
]),
new FileStorageShareCreate([
'name' => 'write',
'path' => '/project/data',
'acl' => [
new FileStorageAclCreate([
'name' => 'test-name',
'target' => '192.168.147.0/24',
'permission' => FileStoragePermission::Rw->value,
]),
new FileStorageAclCreate([
'name' => 'test-name',
'target' => 'local.domain',
'permission' => FileStoragePermission::Rw->value,
]),
],
]),
],
'labels' => [
new FileStorageLabelCreate([
'key' => 'environment',
'value' => 'production',
]),
],
]),
);
Parameters
$name: string
$zone: string — Indicates the zone where the service will be created.
$configuredStatus: string
$sizeGib: int
$encrypted: ?bool — Indicates whether encryption at rest is enabled for the service.
$networks: ?array
$shares: ?array
$labels: ?array — Labels
$client->fileStorage->getFileStorage($serviceUuid) -> FileStorageServiceDetailResponse
Description
Returns managed File Storage details by given {service_uuid}.
Usage
$client->fileStorage->getFileStorage(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
);
Parameters
$serviceUuid: string — Service UUID
$client->fileStorage->replaceFileStorage($serviceUuid, $request) -> FileStorageServiceDetailResponse
Description
Replaces existing File Storage service by given {service_uuid}.
Usage
$client->fileStorage->replaceFileStorage(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
new FileStorageServiceReplace([
'name' => 'test-name',
'configuredStatus' => FileStorageConfiguredStatus::Started->value,
'sizeGib' => 250,
'networks' => [
new FileStorageNetworkCreate([
'uuid' => '03720d07-80a9-41ac-90b0-68a932109339',
'name' => 'net',
'family' => FileStorageNetworkFamily::IPv4->value,
'ipAddress' => '192.168.147.120',
]),
],
'labels' => [
new FileStorageLabelCreate([
'key' => 'environment',
'value' => 'production',
]),
],
]),
);
Parameters
$serviceUuid: string — Service UUID
$name: string
$configuredStatus: string
$sizeGib: int
$networks: ?array
$labels: ?array — Labels
$client->fileStorage->deleteFileStorage($serviceUuid)
Description
Deletes existing File Storage service by given {service_uuid}.
Usage
$client->fileStorage->deleteFileStorage(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
);
Parameters
$serviceUuid: string — Service UUID
$client->fileStorage->modifyFileStorage($serviceUuid, $request) -> FileStorageServiceDetailResponse
Description
Modifies existing File Storage service by given {service_uuid}.
Usage
$client->fileStorage->modifyFileStorage(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
new FileStorageServiceModify([
'name' => 'test-name',
'configuredStatus' => FileStorageConfiguredStatus::Started->value,
'sizeGib' => 250,
'networks' => [
new FileStorageNetworkCreate([
'uuid' => '03720d07-80a9-41ac-90b0-68a932109339',
'name' => 'net',
'family' => FileStorageNetworkFamily::IPv4->value,
'ipAddress' => '192.168.147.120',
]),
],
'labels' => [
new FileStorageLabelCreate([
'key' => 'environment',
'value' => 'production',
]),
],
]),
);
Parameters
$serviceUuid: string — Service UUID
$name: ?string
$configuredStatus: ?string
$sizeGib: ?int
$networks: ?array
$labels: ?array
$client->fileStorage->listFileStorageNetworks($serviceUuid) -> array
Description
Returns a list of available service networks by given {service_uuid}.
Usage
$client->fileStorage->listFileStorageNetworks(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
);
Parameters
$serviceUuid: string — Service UUID
$client->fileStorage->createFileStorageNetwork($serviceUuid, $request) -> FileStorageNetworkDetailResponse
Description
Creates a new service network by given {service_uuid}.
Usage
$client->fileStorage->createFileStorageNetwork(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
new CreateFileStorageNetworkRequest([
'body' => new FileStorageNetworkCreate([
'uuid' => '03720d07-80a9-41ac-90b0-68a932109339',
'name' => 'test-name',
'family' => FileStorageNetworkFamily::IPv4->value,
'ipAddress' => '10.20.30.40',
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$request: FileStorageNetworkCreate
$client->fileStorage->getFileStorageNetwork($serviceUuid, $networkName) -> FileStorageNetworkDetailResponse
Description
Returns service network details by given {service_uuid} and {network_name}.
Usage
$client->fileStorage->getFileStorageNetwork(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
'test-name',
);
Parameters
$serviceUuid: string — Service UUID
$networkName: string — The name of the network.
$client->fileStorage->deleteFileStorageNetwork($serviceUuid, $networkName)
Description
Deletes existing network by given {service_uuid} and {network_name}.
Usage
$client->fileStorage->deleteFileStorageNetwork(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
'test-name',
);
Parameters
$serviceUuid: string — Service UUID
$networkName: string — The name of the network.
$client->fileStorage->modifyFileStorageNetwork($serviceUuid, $networkName, $request) -> FileStorageNetworkDetailResponse
Description
Modifies existing service network by given {service_uuid} and {network_name}.
Usage
$client->fileStorage->modifyFileStorageNetwork(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
'test-name',
new FileStorageNetworkModify([
'uuid' => '03720d07-80a9-41ac-90b0-68a932109339',
'name' => 'test-name',
'family' => FileStorageNetworkFamily::IPv4->value,
'ipAddress' => '10.20.30.40',
]),
);
Parameters
$serviceUuid: string — Service UUID
$networkName: string — The name of the network.
$uuid: ?string
$name: ?string
$family: ?string
$ipAddress: ?string
$client->fileStorage->listFileStorageShares($serviceUuid) -> array
Description
Returns a list of available service shares by given {service_uuid}.
Usage
$client->fileStorage->listFileStorageShares(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
);
Parameters
$serviceUuid: string — Service UUID
$client->fileStorage->createFileStorageShare($serviceUuid, $request) -> FileStorageShareDetailResponse
Description
Creates a new service share by given {service_uuid}.
Usage
$client->fileStorage->createFileStorageShare(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
new CreateFileStorageShareRequest([
'body' => new FileStorageShareCreate([
'name' => 'read',
'path' => '/public',
'acl' => [
new FileStorageAclCreate([
'name' => 'test-name',
'target' => '192.168.147.0/24',
'permission' => FileStoragePermission::Ro->value,
]),
],
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$request: FileStorageShareCreate
$client->fileStorage->getFileStorageShare($serviceUuid, $shareName) -> FileStorageShareDetailResponse
Description
Returns service share details by given {service_uuid} and {share_name}.
Usage
$client->fileStorage->getFileStorageShare(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
'test-name',
);
Parameters
$serviceUuid: string — Service UUID
$shareName: string — The name of the share.
$client->fileStorage->deleteFileStorageShare($serviceUuid, $shareName)
Description
Deletes existing share by given {service_uuid} and {share_name}.
Usage
$client->fileStorage->deleteFileStorageShare(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
'test-name',
);
Parameters
$serviceUuid: string — Service UUID
$shareName: string — The name of the share.
$client->fileStorage->modifyFileStorageShare($serviceUuid, $shareName, $request) -> FileStorageShareDetailResponse
Description
Modifies existing service share by given {service_uuid} and {share_name}.
Usage
$client->fileStorage->modifyFileStorageShare(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
'test-name',
new FileStorageShareModify([
'name' => 'test-name',
'acl' => [
new FileStorageAclCreate([
'name' => 'test-name',
'target' => '192.168.25.0/24',
'permission' => FileStoragePermission::Ro->value,
]),
],
]),
);
Parameters
$serviceUuid: string — Service UUID
$shareName: string — The name of the share.
$name: ?string — A resource name.
$acl: ?array
$client->fileStorage->listFileStorageAcls($serviceUuid, $shareName) -> array
Description
Returns a list of available ACLs by given {service_uuid} and {share_name}.
Usage
$client->fileStorage->listFileStorageAcls(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
'test-name',
);
Parameters
$serviceUuid: string — Service UUID
$shareName: string — The name of the share.
$client->fileStorage->createFileStorageAcl($serviceUuid, $shareName, $request) -> FileStorageAclDetailResponse
Description
Creates a new share ACL by given {service_uuid} and {share_name}.
Usage
$client->fileStorage->createFileStorageAcl(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
'test-name',
new CreateFileStorageAclRequest([
'body' => new FileStorageAclCreate([
'name' => 'test-name',
'target' => '192.168.25.147',
'permission' => FileStoragePermission::Ro->value,
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$shareName: string — The name of the share.
$request: FileStorageAclCreate
$client->fileStorage->getFileStorageAcl($serviceUuid, $shareName, $aclName) -> FileStorageAclDetailResponse
Description
Returns ACL details by given {service_uuid}, {share_name} and {acl_name}.
Usage
$client->fileStorage->getFileStorageAcl(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
'test-name',
'test-name',
);
Parameters
$serviceUuid: string — Service UUID
$shareName: string — The name of the share.
$aclName: string — The name of the ACL.
$client->fileStorage->deleteFileStorageAcl($serviceUuid, $shareName, $aclName)
Description
Deletes existing ACL by given {service_uuid}, {share_name} and {acl_name}.
Usage
$client->fileStorage->deleteFileStorageAcl(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
'test-name',
'test-name',
);
Parameters
$serviceUuid: string — Service UUID
$shareName: string — The name of the share.
$aclName: string — The name of the ACL.
$client->fileStorage->modifyFileStorageAcl($serviceUuid, $shareName, $aclName, $request) -> FileStorageAclDetailResponse
Description
Modifies existing ACL by given {service_uuid}, {share_name} and {acl_name}.
Usage
$client->fileStorage->modifyFileStorageAcl(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
'test-name',
'test-name',
new FileStorageAclModify([
'name' => 'test-name',
'target' => '192.168.25.0/24',
'permission' => FileStoragePermission::Rw->value,
]),
);
Parameters
$serviceUuid: string — Service UUID
$shareName: string — The name of the share.
$aclName: string — The name of the ACL.
$name: ?string
$target: ?string — The target of the ACL entry. It can be an IP Address, Network Prefix or a wildcard.
$permission: ?string
$client->fileStorage->listFileStorageLabels($serviceUuid) -> array
Description
Returns a list of available service labels by given {service_uuid}.
Usage
$client->fileStorage->listFileStorageLabels(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
);
Parameters
$serviceUuid: string — Service UUID
$client->fileStorage->createFileStorageLabel($serviceUuid, $request) -> FileStorageLabelDetails
Description
Creates a new label by given {service_uuid}. Labels are used for service filtering.
Usage
$client->fileStorage->createFileStorageLabel(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
new CreateFileStorageLabelRequest([
'body' => new FileStorageLabelCreate([
'key' => 'environment',
'value' => 'production',
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$request: FileStorageLabelCreate
$client->fileStorage->getFileStorageLabel($serviceUuid, $labelKey) -> FileStorageLabelDetails
Description
Returns label details by given {service_uuid} and {key}.
Usage
$client->fileStorage->getFileStorageLabel(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
'environment',
);
Parameters
$serviceUuid: string — Service UUID
$labelKey: string — The key of the label.
$client->fileStorage->deleteFileStorageLabel($serviceUuid, $labelKey)
Description
Deletes existing label by given {service_uuid} and {key}.
Usage
$client->fileStorage->deleteFileStorageLabel(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
'environment',
);
Parameters
$serviceUuid: string — Service UUID
$labelKey: string — The key of the label.
$client->fileStorage->modifyFileStorageLabel($serviceUuid, $labelKey, $request) -> FileStorageLabelDetails
Description
Modifies existing label by given {service_uuid} and {key}.
Usage
$client->fileStorage->modifyFileStorageLabel(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
'environment',
new FileStorageLabelModify([
'key' => 'environment',
'value' => 'production',
]),
);
Parameters
$serviceUuid: string — Service UUID
$labelKey: string — The key of the label.
$key: ?string
$value: ?string
$client->fileStorage->getFileStorageCurrentState($serviceUuid) -> FileStorageServiceDetailResponse
Description
Returns the current state of the File Storage service by given {service_uuid}.
Usage
$client->fileStorage->getFileStorageCurrentState(
'17fd43a5-a97e-44f7-98a8-0a787da67069',
);
Parameters
$serviceUuid: string — Service UUID
database
$client->database->listDatabaseTypes() -> array
Description
Returns a list of available database types. Contains available legacy plans, zones, database versions supported and the configuration properties for each database. PostgreSQL and MySQL componentised (rdb.) plans are selected with the plan_ request fields instead of a listed plan name.
Usage
$client->database->listDatabaseTypes();
$client->database->listDatabasePlans() -> DatabasePlansResponse
Description
Lists available componentised database plans
Usage
$client->database->listDatabasePlans();
$client->database->getDatabaseType($serviceTypeName) -> DatabaseServiceTypeResponse
Description
Returns database type details by given {database_type}. Contains available legacy plans, zones, database versions supported and configuration properties. PostgreSQL and MySQL componentised (rdb.) plans are selected with the plan_ request fields instead of a listed plan name.
Usage
$client->database->getDatabaseType(
DatabaseServiceType::Mysql->value,
);
Parameters
$serviceTypeName: string — Service type parameter
$client->database->listDatabases($request) -> array
Description
Returns a list of all available Managed Database services. Depending on their database type, Managed Databases services will have different details.
Usage
$client->database->listDatabases(
new ListDatabasesRequest([
'limit' => 10,
'offset' => 0,
]),
);
Parameters
$limit: ?int — Number of entries to receive at most.
$offset: ?int — Offset for retrieved results.
$sort: ?string — Sort results by the specified field. Prefix with ‘-‘ for descending order. Supported fields: created_at, name (service hostname), operational_state (service status), zone (location).
$client->database->createDatabase($request) -> DatabaseServiceInformationResponse
Description
Creates a new Managed Database instance. New databases are started by default. An initial backup is created automatically on startup and the API will be fully functional only after this backup has been created. The creation might take a while. Note that different databases have different properties that can be passed on creation. For PostgreSQL and MySQL, select the plan with the plan_compute, plan_node_count, plan_storage_gib and plan_backups fields; the plan name field is deprecated for these engines.
Usage
$client->database->createDatabase(
new DatabaseServiceCreateOpenApi([
'hostnamePrefix' => 'doc-api-unique-prefix',
'title' => 'my-managed-database',
'type' => DatabaseServiceType::Mysql->value,
'zone' => 'de-fra1',
'terminationProtection' => false,
'maintenance' => new DatabaseServiceCreateOpenApiMaintenance([
'dow' => DatabaseMaintenanceDow::Sunday->value,
'time' => '05:00:00',
]),
'networks' => [
new DatabaseNetworkCreate([
'uuid' => '03631160-d57a-4926-ad48-a2f828229dcb',
'name' => 'example-network-1',
'type' => DatabaseNetworkType::Private_->value,
'family' => DatabaseNetworkFamily::IPv4->value,
]),
new DatabaseNetworkCreate([
'uuid' => '03631160-d57a-4926-ad48-a2f828229dcb',
'name' => 'example-network-2',
'type' => DatabaseNetworkType::Private_->value,
'family' => DatabaseNetworkFamily::IPv4->value,
]),
],
'labels' => [
new DatabaseLabelCreate([
'key' => 'env',
'value' => 'staging',
]),
new DatabaseLabelCreate([
'key' => 'foo',
'value' => 'bar',
]),
],
'properties' => new DatabaseServicePropertiesMysql([
'automaticUtilityNetworkIpFilter' => true,
'ipFilter' => [
'ip_filter',
],
]),
]),
);
Parameters
$hostnamePrefix: string — Hostname prefix for the service nodes.
$title: string — Human-readable title for the service.
$type: string
$zone: string — Zone where the service is created.
$setServiceUuid: ?string — Optional UUID to assign to the created service.
$plan: ?string — Deprecated: prefer the plan_* selection fields (plan_compute, plan_node_count, plan_storage_gib, plan_backups) for PostgreSQL and MySQL. The plan name remains supported, and required for engines without componentised plans. For componentised (rdb.*) plans the storage segment is the desired TOTAL storage per node: any total reachable from a catalog plan’s included storage in the plan’s storage steps (within its cap) is a valid plan name, e.g. rdb.standard.2x-2CPU-8GB-120GB-regular selects the 80GB catalog plan with a 40GB dynamic top-up.
$planCompute: ?string — Plan selection: compute shape combining family, CPU and memory as one token, as listed in the plan catalog components. PostgreSQL and MySQL only.
$planNodeCount: ?int — Plan selection: number of nodes.
$planStorageGib: ?int — Plan selection: desired TOTAL storage per node in GiB. Resolution picks the plan whose included storage matches, or tops the closest plan up with dynamic additional storage within the allowed limits. Mutually exclusive with additional_disk_space_gib.
$planBackups: ?string — Plan selection: backup tier. PostgreSQL and MySQL tiered plans only.
$additionalDiskSpaceGib: ?int — Additional disk space in GiB. Legacy plans only: componentised (rdb.*) plans set storage as a total via plan_storage_gib or the plan name.
$terminationProtection: ?bool — When enabled, the service cannot be deleted until termination protection is disabled.
$maintenance: ?DatabaseServiceCreateOpenApiMaintenance — Weekly maintenance window.
$networks: ?array — SDN networks to attach to the service.
$labels: ?array — Labels used for service filtering.
$serviceIntegrations: ?array — Service integrations to configure on creation.
$properties: DatabaseServicePropertiesMysql|DatabaseServicePropertiesPg|DatabaseServicePropertiesRedis|DatabaseServicePropertiesOpensearch|DatabaseServicePropertiesValkey|null — Engine-specific configuration properties. The allowed keys depend on the selected service type; provide the property set matching the chosen type.
$client->database->getDatabase($uuid) -> DatabaseServiceInformationResponse
Description
Returns details of a Managed Database service by its {uuid}.
Usage
$client->database->getDatabase(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->deleteDatabase($uuid)
Description
Deletes a specified Managed Database. All data will be erased and lost, including backups. If the service is not powered off, it will be powered off before deletion. The state of the service can be anything.
Usage
$client->database->deleteDatabase(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->modifyDatabase($uuid, $request) -> DatabaseServiceInformationResponse
Description
Modifies Managed Database service details by its {uuid} including upgrading plans, migration to other zones and database type-specific configurations. For PostgreSQL and MySQL, change the plan with the plan_compute, plan_node_count, plan_storage_gib and plan_backups fields; the plan name field is deprecated for these engines.
Usage
$client->database->modifyDatabase(
'01234567-89ab-cdef-0123-456789abcdef',
new DatabaseServiceModifyOpenApi([
'title' => 'my-managed-database',
'powered' => true,
'zone' => 'de-fra1',
'terminationProtection' => false,
'maintenance' => new DatabaseServiceModifyOpenApiMaintenance([
'dow' => DatabaseMaintenanceDow::Sunday->value,
'time' => '12:00:00',
]),
'networks' => [
new DatabaseNetworkCreate([
'uuid' => '03631160-d57a-4926-ad48-a2f828229dcb',
'name' => 'example-network-1',
'type' => DatabaseNetworkType::Private_->value,
'family' => DatabaseNetworkFamily::IPv4->value,
]),
],
'properties' => new DatabaseServicePropertiesMysql([
'automaticUtilityNetworkIpFilter' => true,
'ipFilter' => [
'ip_filter',
],
]),
]),
);
Parameters
$uuid: string — Service UUID
$title: ?string — Human-readable title for the service.
$type: ?string
$powered: ?bool — Desired power state of the service.
$zone: ?string — Zone to migrate the service to.
$plan: ?string — Deprecated: prefer the plan_* selection fields (plan_compute, plan_node_count, plan_storage_gib, plan_backups) for PostgreSQL and MySQL. The plan name remains supported, and required for engines without componentised plans. For componentised (rdb.*) plans the storage segment is the desired TOTAL storage per node: any total reachable from a catalog plan’s included storage in the plan’s storage steps (within its cap) is a valid plan name, e.g. rdb.standard.2x-2CPU-8GB-120GB-regular selects the 80GB catalog plan with a 40GB dynamic top-up.
$planCompute: ?string — Plan selection: compute shape combining family, CPU and memory as one token, as listed in the plan catalog components. PostgreSQL and MySQL only.
$planNodeCount: ?int — Plan selection: number of nodes.
$planStorageGib: ?int — Plan selection: desired TOTAL storage per node in GiB. Resolution picks the plan whose included storage matches, or tops the closest plan up with dynamic additional storage within the allowed limits. Mutually exclusive with additional_disk_space_gib.
$planBackups: ?string — Plan selection: backup tier. PostgreSQL and MySQL tiered plans only.
$additionalDiskSpaceGib: ?int — Additional disk space in GiB. Legacy plans only: componentised (rdb.*) plans set storage as a total via plan_storage_gib or the plan name.
$terminationProtection: ?bool — When enabled, the service cannot be deleted until termination protection is disabled.
$maintenance: ?DatabaseServiceModifyOpenApiMaintenance — Weekly maintenance window.
$networks: ?array — SDN networks attached to the service.
$labels: ?array — Labels used for service filtering.
$properties: DatabaseServicePropertiesMysql|DatabaseServicePropertiesPg|DatabaseServicePropertiesRedis|DatabaseServicePropertiesOpensearch|DatabaseServicePropertiesValkey|null — Engine-specific configuration properties. The allowed keys depend on the service type; provide the property set matching the service’s type.
$client->database->modifyDatabaseType($uuid, $request) -> DatabaseServiceInformationResponse
Description
Update a service’s type by the given {service-uuid}.
Usage
$client->database->modifyDatabaseType(
'01234567-89ab-cdef-0123-456789abcdef',
new DatabaseServiceTypeModify([
'targetType' => 'primary',
]),
);
Parameters
$uuid: string — Service UUID
$targetType: string — Service type
$client->database->cloneDatabase($uuid, $request) -> DatabaseServiceInformationResponse
Description
Creates a clone of a Managed Database service based on its {uuid}. It is possible to change location, plans and use the point in time feature to clone your service at a specific time using your backups. For PostgreSQL and MySQL, select the clone’s plan with the plan_compute, plan_node_count, plan_storage_gib and plan_backups fields; the plan name field is deprecated for these engines.
Usage
$client->database->cloneDatabase(
'01234567-89ab-cdef-0123-456789abcdef',
new CloneDatabaseRequest([
'body' => new DatabaseServiceCloneMysql([
'hostnamePrefix' => 'dev',
'cloneTime' => new DateTime('2024-01-30T15:04:05Z'),
'backupName' => 'daily-backup-2024-01-30',
'zone' => 'fi-hel1',
'terminationProtection' => false,
'maintenance' => new DatabaseServiceCloneMysqlMaintenance([
'dow' => DatabaseMaintenanceDow::Monday->value,
'time' => '03:00:00',
]),
]),
]),
);
Parameters
$uuid: string — Service UUID
$request: DatabaseServiceCloneMysql|DatabaseServiceClonePg|DatabaseServiceCloneRedis|DatabaseServiceCloneOpensearch|DatabaseServiceCloneValkey
$client->database->listDatabaseNetworks($uuid) -> array
Description
Returns a list of attached SDN networks to a Managed Database service by its {uuid}.
Usage
$client->database->listDatabaseNetworks(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->createDatabaseNetwork($uuid, $request) -> DatabaseNetworkInformationDetailsResponse
Description
Attaches an SDN network to a Managed Database service by its {uuid}.
Usage
$client->database->createDatabaseNetwork(
'01234567-89ab-cdef-0123-456789abcdef',
new CreateDatabaseNetworkRequest([
'body' => new DatabaseNetworkCreate([
'name' => 'my-network',
'type' => DatabaseNetworkType::Private_->value,
'family' => DatabaseNetworkFamily::IPv4->value,
]),
]),
);
Parameters
$uuid: string — Service UUID
$request: DatabaseNetworkCreate
$client->database->getDatabaseNetwork($uuid, $networkName) -> DatabaseNetworkInformationDetailsResponse
Description
Returns the attached SDN network details to service by its {uuid} and {network_name}.
Usage
$client->database->getDatabaseNetwork(
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$networkName: string — Network UUID
$client->database->deleteDatabaseNetwork($uuid, $networkName)
Description
Detaches an existing SDN network from a Managed Database service by its {uuid} and {network_name}.
Usage
$client->database->deleteDatabaseNetwork(
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$networkName: string — Network UUID
$client->database->upgradeDatabase($uuid, $request) -> DatabaseServiceInformationResponse
Description
Upgrades your PostgreSQL Managed Database service database to a newer major version. Downgrades are not permitted.
Usage
$client->database->upgradeDatabase(
'01234567-89ab-cdef-0123-456789abcdef',
new DatabaseServiceUpgrade([
'targetVersion' => '12',
]),
);
Parameters
$uuid: string — Service UUID
$targetVersion: string — Version to upgrade the service
$client->database->listDatabaseLabels($uuid) -> array
Description
Returns a list of available service labels by given {service_uuid}.
Usage
$client->database->listDatabaseLabels(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->createDatabaseLabel($uuid, $request) -> DatabaseLabelResponse
Description
Creates a new label by given {service_uuid}. Labels used for service filtering.
Usage
$client->database->createDatabaseLabel(
'01234567-89ab-cdef-0123-456789abcdef',
new CreateDatabaseLabelRequest([
'body' => new DatabaseLabelCreate([
'key' => 'environment',
'value' => 'production',
]),
]),
);
Parameters
$uuid: string — Service UUID
$request: DatabaseLabelCreate
$client->database->getDatabaseLabel($uuid, $labelKey) -> DatabaseLabelResponse
Description
Returns label details by given {service_uuid} and {key}.
Usage
$client->database->getDatabaseLabel(
'01234567-89ab-cdef-0123-456789abcdef',
'foo',
);
Parameters
$uuid: string — Service UUID
$labelKey: string — Label ID
$client->database->deleteDatabaseLabel($uuid, $labelKey)
Description
Deletes existing label by given {service_uuid} and {key}.
Usage
$client->database->deleteDatabaseLabel(
'01234567-89ab-cdef-0123-456789abcdef',
'foo',
);
Parameters
$uuid: string — Service UUID
$labelKey: string — Label ID
$client->database->modifyDatabaseLabel($uuid, $labelKey, $request) -> DatabaseLabelResponse
Description
Modifies existing label by given {service_uuid} and {key}.
Usage
$client->database->modifyDatabaseLabel(
'01234567-89ab-cdef-0123-456789abcdef',
'foo',
new DatabaseLabelModify([
'key' => 'environment',
'value' => 'production',
]),
);
Parameters
$uuid: string — Service UUID
$labelKey: string — Label ID
$key: ?string
$value: ?string
$client->database->getDatabaseAvailableExtensions($uuid) -> array
Description
Returns a list of available PostgreSQL extensions for the Managed Database service by its {service-uuid}. Only supported for PostgreSQL services.
Usage
$client->database->getDatabaseAvailableExtensions(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->getPgAvailableExtensions() -> array
Description
Returns a list of available PostgreSQL extensions grouped by PostgreSQL version.
Usage
$client->database->getPgAvailableExtensions();
$client->database->getDatabaseTypeVersions() -> array
Description
Returns a list of supported Managed Database service versions.
Usage
$client->database->getDatabaseTypeVersions();
$client->database->getDatabaseAccessControl($uuid) -> DatabaseAccessControlSettingsResponse
Description
Return access controls settings for the OpenSearch Managed Database service {uuid}.
Usage
$client->database->getDatabaseAccessControl(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->modifyDatabaseAccessControl($uuid, $request) -> DatabaseAccessControlSettingsResponse
Description
Modifies the user {username} access control for the Managed Database service {uuid}.
Usage
$client->database->modifyDatabaseAccessControl(
'01234567-89ab-cdef-0123-456789abcdef',
new DatabaseServiceAclModify([
'accessControl' => true,
]),
);
Parameters
$uuid: string — Service UUID
$accessControl: ?bool — Enables OpenSearch access control
$extendedAccessControl: ?bool — Enables OpenSearch extended access control
$client->database->getDatabaseSecurity($uuid) -> DatabaseOpenSearchSecurityPluginStatusResponse
Description
Returns Security management status for the OpenSearch Managed Database service {uuid}.
Usage
$client->database->getDatabaseSecurity(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->enableDatabaseSecurityAdmin($uuid, $request) -> DatabaseOpenSearchSecurityPluginStatusResponse
Description
Enables Security management admin for the OpenSearch Managed Database service {uuid}.
Usage
$client->database->enableDatabaseSecurityAdmin(
'01234567-89ab-cdef-0123-456789abcdef',
new DatabaseServiceSecurityEnable([
'adminPassword' => 'Str0ngP@ssw0rd!',
]),
);
Parameters
$uuid: string — Service UUID
$adminPassword: string — Security admin password
$client->database->modifyDatabaseSecurityAdmin($uuid, $request) -> DatabaseOpenSearchSecurityPluginStatusResponse
Description
Modifies Security management admin password for the OpenSearch Managed Database service {uuid}.
Usage
$client->database->modifyDatabaseSecurityAdmin(
'01234567-89ab-cdef-0123-456789abcdef',
new DatabaseServiceSecurityModify([
'adminPassword' => 'Curr3nt@Passw0rd!',
'newPassword' => 'N3w@Str0ngPassw0rd!',
]),
);
Parameters
$uuid: string — Service UUID
$adminPassword: string — Current admin password
$newPassword: string — New admin password
$client->database->listDatabaseIntegrationEndpoints() -> array
Description
Returns a list of available integration endpoints.
Usage
$client->database->listDatabaseIntegrationEndpoints();
$client->database->createDatabaseIntegrationEndpoint($request) -> DatabaseIntegrationEndpointResponse
Description
Creates a new integration endpoint.
Usage
$client->database->createDatabaseIntegrationEndpoint(
new DatabaseIntegrationEndpointCreate([
'type' => DatabaseIntegrationEndpoint::Logs->value,
'name' => 'webhook-endpoint',
]),
);
Parameters
$type: string
$name: string — The name of the integration endpoint.
$properties: ?array — A key-value map of properties specific to the integration endpoint type.
$client->database->getDatabaseIntegrationEndpoint($integrationUuid) -> DatabaseIntegrationEndpointResponse
Description
Returns integration endpoint details by given {integration-uuid}.
Usage
$client->database->getDatabaseIntegrationEndpoint(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$integrationUuid: string — Integration UUID
$client->database->deleteDatabaseIntegrationEndpoint($integrationUuid)
Description
Deletes existing integration endpoint by given {integration-uuid}.
Usage
$client->database->deleteDatabaseIntegrationEndpoint(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$integrationUuid: string — Integration UUID
$client->database->modifyDatabaseIntegrationEndpoint($integrationUuid, $request) -> DatabaseIntegrationEndpointResponse
Description
Modifies existing integration endpoint by given {integration-uuid}.
Usage
$client->database->modifyDatabaseIntegrationEndpoint(
'01234567-89ab-cdef-0123-456789abcdef',
new DatabaseIntegrationEndpointModify([]),
);
Parameters
$integrationUuid: string — Integration UUID
$properties: ?array
$client->database->getDatabaseAccountCa() -> DatabaseAccountCaResponse
Description
Returns the CA certificate. Every customer main account has a private Certificate Authority (CA) that signs certificates for internal use. Managed Database service types, such as PostgreSQL, use it for external connections. To access these services, you must download and configure the certificate on your browser or client.
Usage
$client->database->getDatabaseAccountCa();
$client->database->listDatabaseAlerts() -> array
Description
Returns all the alerts associated with your Managed Database services.
Usage
$client->database->listDatabaseAlerts();
$client->database->getDatabaseStatus($uuid) -> DatabaseServiceStatusResponse
Description
Get a service’s status by the given {service-uuid}.
Usage
$client->database->getDatabaseStatus(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->getDatabaseVersions($uuid) -> array
Description
Returns available versions of the Managed Database service by its {uuid}.
Usage
$client->database->getDatabaseVersions(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->startDatabaseManualMaintenance($uuid) -> DatabaseUpCloudApiResponse
Description
Start maintenance updates for your Managed Database service if any updates are pending.
Usage
$client->database->startDatabaseManualMaintenance(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->enableDatabaseTemporaryWrites($uuid) -> DatabaseUpCloudApiResponse
Description
Enable temporary writes by the given {service-uuid}.
Usage
$client->database->enableDatabaseTemporaryWrites(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->getDatabaseMigrationStatus($uuid) -> DatabaseServiceMigrationStatusResponse
Description
Returns details about the migration progress over time of a Managed database service by its {uuid}.
Usage
$client->database->getDatabaseMigrationStatus(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->getDatabaseAlerts($uuid) -> array
Description
Returns alerts for Managed Database service identified by {uuid}.
Usage
$client->database->getDatabaseAlerts(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->getDatabaseMetrics($uuid) -> array
Description
Returns metrics related to a Managed Database service by its {uuid} and query parameter {period}.
Usage
$client->database->getDatabaseMetrics(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->getDatabaseQueryStatistics($uuid, $request) -> DatabaseQueryStatisticsResponse
Description
Returns a list of query statistics for the Managed Database service by its {uuid} and optional query parameters {limit}, {offset} and {order}. Query statistics will differ depending on the database type.
Usage
$client->database->getDatabaseQueryStatistics(
'01234567-89ab-cdef-0123-456789abcdef',
new GetDatabaseQueryStatisticsRequest([
'limit' => 10,
'offset' => 0,
'order' => 'asc',
]),
);
Parameters
$uuid: string — Service UUID
$limit: ?int — Number of entries to receive at most.
$offset: ?int — Offset for retrieved results.
$order: ?string — Sort order
$client->database->getDatabaseLogs($uuid, $request) -> DatabaseLogListResponse
Description
Returns Managed Database service system-level logs by its {uuid} and optional query parameters {limit}, {offset} and {order}.
Usage
$client->database->getDatabaseLogs(
'01234567-89ab-cdef-0123-456789abcdef',
new GetDatabaseLogsRequest([
'limit' => 10,
'offset' => 0,
'order' => 'asc',
]),
);
Parameters
$uuid: string — Service UUID
$limit: ?int — Number of entries to receive at most.
$offset: ?int — Offset for retrieved results.
$order: ?string — Sort order
$client->database->listDatabaseConnectionPools($uuid, $request) -> array
Description
Returns a list of available connection pools for a Managed Database service. Connection pools are available only for PostgreSQL database services.
Usage
$client->database->listDatabaseConnectionPools(
'01234567-89ab-cdef-0123-456789abcdef',
new ListDatabaseConnectionPoolsRequest([
'sort' => 'asc',
]),
);
Parameters
$uuid: string — Service UUID
$sort: ?string — Order of returned results.
$client->database->createDatabaseConnectionPool($uuid, $request) -> DatabaseConnectionPoolResponse
Description
Creates a connection pool for the Managed Database service {uuid}. Connection pool endpoints are for PostgreSQL Managed Databases only.
Usage
$client->database->createDatabaseConnectionPool(
'01234567-89ab-cdef-0123-456789abcdef',
new DatabaseConnectionPoolCreate([
'database' => 'defaultdb',
'poolMode' => DatabaseConnectionPoolCreatePoolMode::Statement->value,
'poolName' => 'readonly-pool',
'poolSize' => 10,
'username' => 'readonly',
]),
);
Parameters
$uuid: string — Service UUID
$database: string — Database
$poolMode: string — Connection Pool mode
$poolName: string — Connection Pool name
$poolSize: int — Connection Pool size
$username: ?string — Connection Pool username
$client->database->getDatabaseConnectionPool($uuid, $poolName) -> DatabaseConnectionPoolResponse
Description
Returns the connection pool {pool-name} details for the Managed Database service {uuid}.
Usage
$client->database->getDatabaseConnectionPool(
'01234567-89ab-cdef-0123-456789abcdef',
'my-service',
);
Parameters
$uuid: string — Service UUID
$poolName: string — Connection Pool Name
$client->database->deleteDatabaseConnectionPool($uuid, $poolName)
Description
Deletes the connection pool {pool-name} for the Managed Database service {uuid}.
Usage
$client->database->deleteDatabaseConnectionPool(
'01234567-89ab-cdef-0123-456789abcdef',
'my-service',
);
Parameters
$uuid: string — Service UUID
$poolName: string — Connection Pool Name
$client->database->modifyDatabaseConnectionPool($uuid, $poolName, $request) -> DatabaseConnectionPoolResponse
Description
Modifies the connection pool {pool-name} for the Managed Database service {uuid}.
Usage
$client->database->modifyDatabaseConnectionPool(
'01234567-89ab-cdef-0123-456789abcdef',
'my-service',
new DatabaseConnectionPoolModify([
'database' => 'defaultdb',
'poolMode' => DatabaseConnectionPoolModifyPoolMode::Session->value,
'poolSize' => 20,
'username' => 'app-user',
]),
);
Parameters
$uuid: string — Service UUID
$poolName: string — Connection Pool Name
$database: ?string — Database
$poolMode: ?string — Connection Pool mode
$poolSize: ?int — Connection Pool size
$username: ?string — Connection Pool username
$client->database->listDatabaseIndices($uuid) -> array
Description
Returns a list of available indices for a Managed Database service {uuid}.
Usage
$client->database->listDatabaseIndices(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->deleteDatabaseIndex($uuid, $indexName)
Description
Deletes the index {index_name} for the Managed Database service {uuid}.
Usage
$client->database->deleteDatabaseIndex(
'01234567-89ab-cdef-0123-456789abcdef',
'my-service',
);
Parameters
$uuid: string — Service UUID
$indexName: string — OpenSearch Index Name
$client->database->listDatabaseIntegrations($uuid) -> array
Description
Returns a list of available service integrations by given {service-uuid}.
Usage
$client->database->listDatabaseIntegrations(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->createDatabaseIntegration($uuid, $request) -> DatabaseServiceIntegrationResponse
Description
Creates a new integration by given {service-uuid}.
Usage
$client->database->createDatabaseIntegration(
'01234567-89ab-cdef-0123-456789abcdef',
new CreateDatabaseIntegrationRequest([
'body' => new DatabaseServiceIntegrationCreate([
'type' => DatabaseServiceIntegration::Logs->value,
'destinationUuid' => '09e86f48-2dcd-4a43-843d-3532ab112c1d',
'properties' => [
'opensearch_index_days_max' => 30,
'opensearch_index_prefix' => "mysql_logs",
],
]),
]),
);
Parameters
$uuid: string — Service UUID
$request: DatabaseServiceIntegrationCreate
$client->database->getDatabaseIntegration($uuid, $integrationUuid) -> DatabaseServiceIntegrationResponse
Description
Returns integration details by given {service-uuid} and {integration-uuid}.
Usage
$client->database->getDatabaseIntegration(
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$integrationUuid: string — Integration UUID
$client->database->deleteDatabaseIntegration($uuid, $integrationUuid)
Description
Deletes existing integration by given {service-uuid} and {integration-uuid}.
Usage
$client->database->deleteDatabaseIntegration(
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$integrationUuid: string — Integration UUID
$client->database->modifyDatabaseIntegration($uuid, $integrationUuid, $request) -> DatabaseServiceIntegrationResponse
Description
Modifies existing integration by given {service-uuid} and {integration-uuid}.
Usage
$client->database->modifyDatabaseIntegration(
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
new DatabaseServiceIntegrationModify([
'properties' => [
'key1' => "value1",
],
]),
);
Parameters
$uuid: string — Service UUID
$integrationUuid: string — Integration UUID
$properties: ?array
$client->database->listDatabaseLogicalDatabases($uuid) -> array
Description
Returns a list of logical databases for a Managed Database service identified by {uuid}.
Usage
$client->database->listDatabaseLogicalDatabases(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->createDatabaseLogicalDatabase($uuid, $request) -> LogicalDatabaseResponse
Description
Creates a new logical database for the Managed Database service {uuid}.
Usage
$client->database->createDatabaseLogicalDatabase(
'01234567-89ab-cdef-0123-456789abcdef',
new LogicalDatabaseCreate([
'name' => 'my_database',
'lcCollate' => 'en_US.UTF-8',
'lcCtype' => 'en_US.UTF-8',
]),
);
Parameters
$uuid: string — Service UUID
$name: string — logical database name
$lcCollate: ?string — Collation order
$lcCtype: ?string — Category of a locale definition source file
$client->database->deleteDatabaseLogicalDatabase($uuid, $databaseName)
Description
Deletes the logical database {database_name} from the Managed Database service {uuid}.
Usage
$client->database->deleteDatabaseLogicalDatabase(
'01234567-89ab-cdef-0123-456789abcdef',
'my-service',
);
Parameters
$uuid: string — Service UUID
$databaseName: string — Database name
$client->database->getDatabasePeeringsStatus($uuid) -> DatabaseServiceNetworkDetailsResponse
Description
Returns networks peering status for a service by its {uuid}. Only available for services using SDN private networks.
Usage
$client->database->getDatabasePeeringsStatus(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->getDatabaseSessions($uuid, $request) -> DatabaseCurrentSessionsResponse
Description
Returns a list of current sessions details for your Managed Database service by its {uuid} and optional query parameters {limit}, {offset} and {order}.
Usage
$client->database->getDatabaseSessions(
'01234567-89ab-cdef-0123-456789abcdef',
new GetDatabaseSessionsRequest([
'limit' => 10,
'offset' => 0,
'order' => 'asc',
]),
);
Parameters
$uuid: string — Service UUID
$limit: ?int — Number of entries to receive at most.
$offset: ?int — Offset for retrieved results.
$order: ?string — Sort order
$client->database->terminateDatabaseSession($uuid, $pid)
Description
Terminates a sessions or kills a running query for a Managed Database service by its {uuid}, session {pid} and optional query parameter {terminate}.
Usage
$client->database->terminateDatabaseSession(
'01234567-89ab-cdef-0123-456789abcdef',
1001,
);
Parameters
$uuid: string — Service UUID
$pid: int — Session PID
$client->database->createDatabaseTask($uuid, $request) -> DatabaseServiceTaskResponse
Description
Creates a task that checks for potential errors before starting a migration or upgrade for a Managed Database service by its {uuid}.
Usage
$client->database->createDatabaseTask(
'01234567-89ab-cdef-0123-456789abcdef',
new DatabaseServiceTaskCreate([
'datasetImport' => new DatabaseServiceTaskCreateDatasetImport([
'datasetName' => 'customer-events',
]),
'operation' => 'dataset_import',
]),
);
Parameters
$uuid: string — Service UUID
$datasetImport: ?DatabaseServiceTaskCreateDatasetImport
$migrationCheck: ?DatabaseServiceTaskCreateMigrationCheck
$upgradeCheck: ?DatabaseServiceTaskCreateUpgradeCheck
$targetVersion: ?string — The target version for upgrade operations.
$operation: string — The operation to be performed.
$client->database->getDatabaseTask($uuid, $taskId) -> DatabaseServiceTaskDetailsResponse
Description
Returns task details of a Managed Database service by its {uuid} and the task {id} obtained from Create Managed Database task.
Usage
$client->database->getDatabaseTask(
'01234567-89ab-cdef-0123-456789abcdef',
1001,
);
Parameters
$uuid: string — Service UUID
$taskId: int — Task ID
$client->database->listDatabaseUsers($uuid) -> array
Description
Returns a list of database users associated with the Managed Database service {uuid}.
Usage
$client->database->listDatabaseUsers(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$uuid: string — Service UUID
$client->database->createDatabaseUser($uuid, $request) -> DatabaseUserResponse
Description
Creates a new user for the Managed Database service {uuid}.
Usage
$client->database->createDatabaseUser(
'01234567-89ab-cdef-0123-456789abcdef',
new DatabaseServiceUserCreate([
'username' => 'api-doc-user',
'password' => 'new-password',
'authentication' => 'caching_sha2_password',
]),
);
Parameters
$uuid: string — Service UUID
$username: string — The username of the service user
$password: ?string — The password of the service user
$authentication: ?string — The authentication method for the service user
$redisAccessControl: ?DatabaseServiceUserCreateRedisAccessControl — Redis access control settings
$pgAccessControl: ?DatabaseServiceUserCreatePgAccessControl — PostgreSQL access control settings
$opensearchAccessControl: ?DatabaseServiceUserCreateOpensearchAccessControl — OpenSearch access control settings
$valkeyAccessControl: ?DatabaseServiceUserCreateValkeyAccessControl — Valkey access control settings
$client->database->getDatabaseUser($uuid, $username) -> DatabaseUserResponse
Description
Returns the user {username} details for the Managed Database service {uuid}.
Usage
$client->database->getDatabaseUser(
'01234567-89ab-cdef-0123-456789abcdef',
'my-service',
);
Parameters
$uuid: string — Service UUID
$username: string — Username identifier
$client->database->deleteDatabaseUser($uuid, $username)
Description
Deletes the user {username} from the Managed Database service {uuid}.
Usage
$client->database->deleteDatabaseUser(
'01234567-89ab-cdef-0123-456789abcdef',
'my-service',
);
Parameters
$uuid: string — Service UUID
$username: string — Username identifier
$client->database->modifyDatabaseUser($uuid, $username, $request) -> DatabaseUserResponse
Description
Modifies the user {username} details for the Managed Database service {uuid}.
Usage
$client->database->modifyDatabaseUser(
'01234567-89ab-cdef-0123-456789abcdef',
'my-service',
new DatabaseServiceUserModify([
'password' => 'new_secure_password_123!',
'authentication' => 'caching_sha2_password',
]),
);
Parameters
$uuid: string — Service UUID
$username: string — Username identifier
$password: ?string — New password for the service user
$authentication: ?string — Authentication method for the service user
$client->database->modifyDatabaseUserAccessControl($uuid, $username, $request) -> DatabaseUserResponse
Description
Return access controls settings for the OpenSearch Managed Database service {uuid}.
Usage
$client->database->modifyDatabaseUserAccessControl(
'01234567-89ab-cdef-0123-456789abcdef',
'my-service',
new DatabaseServiceUserAclModify([
'redisAccessControl' => new DatabaseServiceUserAclModifyRedisAccessControl([
'categories' => [
'@admin',
'@read',
],
'channels' => [
'news',
'alerts',
],
'commands' => [
'GET',
'SET',
],
'keys' => [
'user:*',
'session:*',
],
]),
'pgAccessControl' => new DatabaseServiceUserAclModifyPgAccessControl([
'allowReplication' => true,
]),
'opensearchAccessControl' => new DatabaseServiceUserAclModifyOpensearchAccessControl([
'rules' => [
new DatabaseServiceUserAclModifyOpensearchAccessControlRulesItem([
'index' => 'logs-*',
'permission' => 'read',
]),
],
]),
'valkeyAccessControl' => new DatabaseServiceUserAclModifyValkeyAccessControl([
'categories' => [
'@write',
],
'channels' => [
'updates',
],
'commands' => [
'DEL',
],
'keys' => [
'cache:*',
],
]),
]),
);
Parameters
$uuid: string — Service UUID
$username: string — Username identifier
$redisAccessControl: ?DatabaseServiceUserAclModifyRedisAccessControl — Redis ACL modification schema
$pgAccessControl: ?DatabaseServiceUserAclModifyPgAccessControl — PostgreSQL replication permission modification schema
$opensearchAccessControl: ?DatabaseServiceUserAclModifyOpensearchAccessControl — OpenSearch index permission modification schema
$valkeyAccessControl: ?DatabaseServiceUserAclModifyValkeyAccessControl — Valkey ACL modification schema
gateway
$client->gateway->listGatewayPlans($request) -> array
Description
List available plans.
Usage
$client->gateway->listGatewayPlans(
new ListGatewayPlansRequest([
'limit' => 10,
'offset' => 0,
]),
);
Parameters
$limit: ?int — Number of entries to receive at most.
$offset: ?int — Offset for retrieved results.
$client->gateway->getGatewayPlan($planName) -> GatewayPlanDetailsResponse
Description
Get plan details.
Usage
$client->gateway->getGatewayPlan(
'advanced',
);
Parameters
$planName: string — Plan identifier
$client->gateway->listGatewayServices($request) -> array
Description
List available services.
Usage
$client->gateway->listGatewayServices(
new ListGatewayServicesRequest([
'limit' => 10,
'offset' => 0,
]),
);
Parameters
$limit: ?int — Number of entries to receive at most.
$offset: ?int — Offset for retrieved results.
$sort: ?string — Sort resources by field. Prefix with ‘-‘ for descending order.
$client->gateway->createGatewayService($request) -> GatewayServiceDetailsResponse
Description
Create a new service.
Usage
$client->gateway->createGatewayService(
new GatewayServiceCreateRequest([
'name' => 'gateway-service',
'plan' => 'development-gwaas-1c2g',
'zone' => 'fi-hel1',
'features' => [
GatewayServiceFeatures::Nat->value,
],
'routers' => [
new GatewayRouterCreateRequest([
'uuid' => 'fedcba98-7654-3210-fedc-ba9876543210',
]),
],
'addresses' => [
new GatewayAddressCreateRequest([
'name' => 'gateway-service',
]),
],
'connections' => [
new GatewayConnectionCreateRequest([
'name' => 'gateway-service',
'type' => GatewayConnectionType::Ipsec->value,
'localRoutes' => [
new GatewayConnectionRouteRequest([
'name' => 'upcloud-example-route',
'type' => GatewayConnectionRouteType::Static_->value,
'staticNetwork' => '10.0.0.0/24',
]),
],
'remoteRoutes' => [
new GatewayConnectionRouteRequest([
'name' => 'remote-example-route',
'type' => GatewayConnectionRouteType::Static_->value,
'staticNetwork' => '10.0.1.0/24',
]),
],
'tunnels' => [
new GatewayTunnelCreateRequest([
'name' => 'example-tunnel-1',
'localAddress' => new GatewayTunnelCreateRequestLocalAddress([
'name' => 'public-ip-1',
]),
'remoteAddress' => new GatewayTunnelCreateRequestRemoteAddress([
'address' => '100.10.0.111',
]),
'ipsec' => new GatewayTunnelCreateRequestIpsec([
'authentication' => new GatewayTunnelCreateRequestIpsecAuthentication([
'authentication' => GatewayIpsecAuthenticationType::Psk->value,
'psk' => '{your PSK}',
]),
]),
'tunnelInternalIp' => '169.254.17.1',
'internalPeerPingInterval' => 0,
]),
],
]),
],
'labels' => [
new GatewayLabelCreateRequest([
'key' => 'environment',
'value' => 'production',
]),
],
'configuredStatus' => GatewayServiceConfiguredStatus::Started->value,
'automaticTunnelInternalIpAllocation' => true,
]),
);
Parameters
$name: string — Name of the service
$plan: string — Plan
$zone: string — Zone
$features: array — Active features
$routers: array — Service routers
$addresses: ?array — Service addresses
$connections: ?array — Service connections
$labels: ?array — Labels
$configuredStatus: string
$automaticTunnelInternalIpAllocation: ?bool — Allocate and use tunnel internal IPs automatically
$client->gateway->getGatewayService($serviceUuid) -> GatewayServiceDetailsResponse
Description
Get service details.
Usage
$client->gateway->getGatewayService(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$client->gateway->replaceGatewayService($serviceUuid, $request) -> GatewayServiceDetailsResponse
Description
Replace service configuration.
Usage
$client->gateway->replaceGatewayService(
'01234567-89ab-cdef-0123-456789abcdef',
new GatewayServiceReplaceRequest([
'name' => 'gateway-service',
'plan' => 'development-gwaas-1c2g',
'configuredStatus' => GatewayServiceConfiguredStatus::Started->value,
'labels' => [
new GatewayLabelCreateRequest([
'key' => 'environment',
'value' => 'production',
]),
],
'automaticTunnelInternalIpAllocation' => true,
]),
);
Parameters
$serviceUuid: string — Service UUID
$name: string — Name of the service
$plan: ?string — Plan
$configuredStatus: string
$connections: mixed — Service connections
$labels: ?array — Labels
$automaticTunnelInternalIpAllocation: ?bool — Allocate and use tunnel internal IPs automatically
$client->gateway->deleteGatewayService($serviceUuid)
Description
Deletes existing service by given {service-identifier}.
Usage
$client->gateway->deleteGatewayService(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$client->gateway->modifyGatewayService($serviceUuid, $request) -> GatewayServiceDetailsResponse
Description
Modify service configuration.
Usage
$client->gateway->modifyGatewayService(
'01234567-89ab-cdef-0123-456789abcdef',
new GatewayServiceModifyRequest([
'name' => 'gateway-service',
'features' => [
GatewayServiceFeatures::Nat->value,
],
'plan' => 'development-gwaas-1c2g',
'configuredStatus' => GatewayServiceConfiguredStatus::Started->value,
'connections' => [
new GatewayConnectionModifyRequest([
'uuid' => '01234567-89ab-cdef-0123-456789abcdef',
'name' => 'gateway-service',
'type' => GatewayConnectionType::Ipsec->value,
'localRoutes' => [
new GatewayConnectionRouteRequest([
'name' => 'modified-routes',
'type' => GatewayConnectionRouteType::Static_->value,
'staticNetwork' => '10.0.22.0/24',
]),
],
]),
],
'labels' => [
new GatewayLabelCreateRequest([
'key' => 'environment',
'value' => 'production',
]),
],
'automaticTunnelInternalIpAllocation' => true,
]),
);
Parameters
$serviceUuid: string — Service UUID
$name: ?string — Name of the service
$features: ?array — Active features
$plan: ?string — Plan
$configuredStatus: ?string
$connections: ?array — Service connections
$labels: ?array — Labels
$automaticTunnelInternalIpAllocation: ?bool — Allocate and use tunnel internal IPs automatically
$client->gateway->flushGatewayNat($serviceUuid)
Description
Flush NAT rules.
Usage
$client->gateway->flushGatewayNat(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$client->gateway->listGatewayConnections($serviceUuid) -> array
Description
List available connections for service.
Usage
$client->gateway->listGatewayConnections(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$client->gateway->createGatewayConnection($serviceUuid, $request) -> GatewayConnectionDetailsResponse
Description
Create a new connection.
Usage
$client->gateway->createGatewayConnection(
'01234567-89ab-cdef-0123-456789abcdef',
new CreateGatewayConnectionRequest([
'body' => new GatewayConnectionCreateRequest([
'name' => 'gateway-service',
'type' => GatewayConnectionType::Ipsec->value,
'localRoutes' => [
new GatewayConnectionRouteRequest([
'name' => 'upcloud-example-route',
'type' => GatewayConnectionRouteType::Static_->value,
'staticNetwork' => '10.0.0.0/24',
]),
],
'remoteRoutes' => [
new GatewayConnectionRouteRequest([
'name' => 'remote-example-route',
'type' => GatewayConnectionRouteType::Static_->value,
'staticNetwork' => '10.0.1.0/24',
]),
],
'tunnels' => [
new GatewayTunnelCreateRequest([
'name' => 'example-tunnel-1',
'localAddress' => new GatewayTunnelCreateRequestLocalAddress([
'name' => 'public-ip-1',
]),
'remoteAddress' => new GatewayTunnelCreateRequestRemoteAddress([
'address' => '100.10.0.111',
]),
'ipsec' => new GatewayTunnelCreateRequestIpsec([
'authentication' => new GatewayTunnelCreateRequestIpsecAuthentication([
'authentication' => GatewayIpsecAuthenticationType::Psk->value,
'psk' => '{your PSK}',
]),
]),
'tunnelInternalIp' => '169.254.17.1',
'internalPeerPingInterval' => 0,
]),
],
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$request: GatewayConnectionCreateRequest
$client->gateway->getGatewayConnection($serviceUuid, $connectionUuid) -> GatewayConnectionDetailsResponse
Description
Get connection details.
Usage
$client->gateway->getGatewayConnection(
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$connectionUuid: string — Connection UUID
$client->gateway->deleteGatewayConnection($serviceUuid, $connectionUuid)
Description
Deletes existing connection by given {connection-identifier}.
Usage
$client->gateway->deleteGatewayConnection(
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$connectionUuid: string — Connection UUID
$client->gateway->modifyGatewayConnection($serviceUuid, $connectionUuid, $request) -> GatewayConnectionDetailsResponse
Description
Modify connection configuration.
Usage
$client->gateway->modifyGatewayConnection(
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
new ModifyGatewayConnectionRequest([
'body' => new GatewayConnectionModifyRequest([
'uuid' => '01234567-89ab-cdef-0123-456789abcdef',
'name' => 'gateway-service',
'type' => GatewayConnectionType::Ipsec->value,
'localRoutes' => [
new GatewayConnectionRouteRequest([
'name' => 'modified-routes',
'type' => GatewayConnectionRouteType::Static_->value,
'staticNetwork' => '10.0.22.0/24',
]),
],
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$connectionUuid: string — Connection UUID
$request: GatewayConnectionModifyRequest
$client->gateway->listGatewayTunnels($serviceUuid, $connectionUuid) -> array
Description
List available tunnels for service.
Usage
$client->gateway->listGatewayTunnels(
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$connectionUuid: string — Connection UUID
$client->gateway->createGatewayTunnel($serviceUuid, $connectionUuid, $request) -> GatewayTunnelDetailsResponse
Description
Create a new tunnel.
Usage
$client->gateway->createGatewayTunnel(
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
new CreateGatewayTunnelRequest([
'body' => new GatewayTunnelCreateRequest([
'name' => 'gateway-service',
'localAddress' => new GatewayTunnelCreateRequestLocalAddress([
'name' => 'gateway-service',
]),
'remoteAddress' => new GatewayTunnelCreateRequestRemoteAddress([
'address' => '203.0.113.10',
]),
'ipsec' => new GatewayTunnelCreateRequestIpsec([
'authentication' => new GatewayTunnelCreateRequestIpsecAuthentication([
'authentication' => GatewayIpsecAuthenticationType::Psk->value,
'psk' => 'MySecretPsk123',
]),
'phase1Algorithms' => [
GatewaySupportedProposalAlgorithms::Aes128->value,
GatewaySupportedProposalAlgorithms::Aes256->value,
GatewaySupportedProposalAlgorithms::Aes128Gcm128->value,
GatewaySupportedProposalAlgorithms::Aes256Gcm128->value,
],
'phase2Algorithms' => [
GatewaySupportedProposalAlgorithms::Aes128->value,
GatewaySupportedProposalAlgorithms::Aes256->value,
GatewaySupportedProposalAlgorithms::Aes128Gcm128->value,
GatewaySupportedProposalAlgorithms::Aes256Gcm128->value,
],
'phase1IntegrityAlgorithms' => [
GatewaySupportedIntegrityAlgorithms::Sha256->value,
GatewaySupportedIntegrityAlgorithms::Sha384->value,
GatewaySupportedIntegrityAlgorithms::Sha512->value,
],
'phase2IntegrityAlgorithms' => [
GatewaySupportedIntegrityAlgorithms::Sha256->value,
GatewaySupportedIntegrityAlgorithms::Sha384->value,
GatewaySupportedIntegrityAlgorithms::Sha512->value,
],
'phase1DhGroupNumbers' => [
16,
18,
19,
],
'phase2DhGroupNumbers' => [
14,
16,
18,
19,
],
]),
'tunnelInternalIp' => '10.0.0.1',
'internalPeerPingInterval' => 0,
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$connectionUuid: string — Connection UUID
$request: GatewayTunnelCreateRequest
$client->gateway->getGatewayTunnel($serviceUuid, $connectionUuid, $tunnelUuid) -> GatewayTunnelDetailsResponse
Description
Get tunnel details.
Usage
$client->gateway->getGatewayTunnel(
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$connectionUuid: string — Connection UUID
$tunnelUuid: string — Tunnel UUID
$client->gateway->deleteGatewayTunnel($serviceUuid, $connectionUuid, $tunnelUuid)
Description
Deletes existing tunnel by given {tunnel-identifier}.
Usage
$client->gateway->deleteGatewayTunnel(
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$connectionUuid: string — Connection UUID
$tunnelUuid: string — Tunnel UUID
$client->gateway->modifyGatewayTunnel($serviceUuid, $connectionUuid, $tunnelUuid, $request) -> GatewayTunnelDetailsResponse
Description
Modify tunnel configuration.
Usage
$client->gateway->modifyGatewayTunnel(
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
new ModifyGatewayTunnelRequest([
'body' => new GatewayTunnelModifyRequest([
'uuid' => '01234567-89ab-cdef-0123-456789abcdef',
'name' => 'gateway-service',
'localAddress' => new GatewayTunnelModifyRequestLocalAddress([
'name' => 'gateway-service',
]),
'remoteAddress' => new GatewayTunnelModifyRequestRemoteAddress([
'address' => '203.0.113.10',
]),
'ipsec' => new GatewayTunnelModifyRequestIpsec([
'authentication' => new GatewayTunnelModifyRequestIpsecAuthentication([
'authentication' => GatewayIpsecAuthenticationType::Psk->value,
'psk' => 'MySecretPsk123',
]),
'phase1Algorithms' => [
GatewaySupportedProposalAlgorithms::Aes128Gcm16->value,
],
'phase2Algorithms' => [
GatewaySupportedProposalAlgorithms::Aes128Gcm16->value,
],
'phase1IntegrityAlgorithms' => [
GatewaySupportedIntegrityAlgorithms::Sha256->value,
GatewaySupportedIntegrityAlgorithms::Sha384->value,
GatewaySupportedIntegrityAlgorithms::Sha512->value,
],
'phase2IntegrityAlgorithms' => [
GatewaySupportedIntegrityAlgorithms::Sha256->value,
GatewaySupportedIntegrityAlgorithms::Sha384->value,
GatewaySupportedIntegrityAlgorithms::Sha512->value,
],
'phase1DhGroupNumbers' => [
16,
18,
19,
],
'phase2DhGroupNumbers' => [
14,
16,
18,
19,
],
]),
'tunnelInternalIp' => '10.0.0.1',
'internalPeerPingInterval' => 0,
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$connectionUuid: string — Connection UUID
$tunnelUuid: string — Tunnel UUID
$request: GatewayTunnelModifyRequest
$client->gateway->listGatewayServiceLabels($serviceUuid) -> array
Description
List available service labels for service.
Usage
$client->gateway->listGatewayServiceLabels(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$client->gateway->createGatewayServiceLabel($serviceUuid, $request)
Description
Create a new service label.
Usage
$client->gateway->createGatewayServiceLabel(
'01234567-89ab-cdef-0123-456789abcdef',
new CreateGatewayServiceLabelRequest([
'body' => new GatewayLabelCreateRequest([
'key' => 'environment',
'value' => 'production',
]),
]),
);
Parameters
$serviceUuid: string — Service UUID
$request: GatewayLabelCreateRequest
$client->gateway->getGatewayServiceLabel($serviceUuid, $labelKey) -> GatewayLabelDetailsResponse
Description
Get service label details.
Usage
$client->gateway->getGatewayServiceLabel(
'01234567-89ab-cdef-0123-456789abcdef',
'environment',
);
Parameters
$serviceUuid: string — Service UUID
$labelKey: string — Label identifier
$client->gateway->deleteGatewayServiceLabel($serviceUuid, $labelKey)
Description
Deletes existing service label by given {service-label-identifier}.
Usage
$client->gateway->deleteGatewayServiceLabel(
'01234567-89ab-cdef-0123-456789abcdef',
'environment',
);
Parameters
$serviceUuid: string — Service UUID
$labelKey: string — Label identifier
$client->gateway->modifyGatewayServiceLabel($serviceUuid, $labelKey, $request)
Description
Modify service label configuration.
Usage
$client->gateway->modifyGatewayServiceLabel(
'01234567-89ab-cdef-0123-456789abcdef',
'environment',
new GatewayLabelModifyRequest([
'key' => 'environment',
'value' => 'production',
]),
);
Parameters
$serviceUuid: string — Service UUID
$labelKey: string — Label identifier
$key: ?string
$value: ?string
$client->gateway->listGatewayAddresses($serviceUuid) -> array
Description
List available service addresses for service.
Usage
$client->gateway->listGatewayAddresses(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$client->gateway->getGatewayAddress($serviceUuid, $addressName) -> GatewayAddressDetailsResponse
Description
Get service address details.
Usage
$client->gateway->getGatewayAddress(
'01234567-89ab-cdef-0123-456789abcdef',
'advanced',
);
Parameters
$serviceUuid: string — Service UUID
$addressName: string — Address identifier
$client->gateway->modifyGatewayAddress($serviceUuid, $addressName, $request) -> GatewayAddressDetailsResponse
Description
Modify existing service address by given {service-address-identifier}.
Usage
$client->gateway->modifyGatewayAddress(
'01234567-89ab-cdef-0123-456789abcdef',
'advanced',
new GatewayAddressModifyRequest([
'address' => '203.0.113.10',
]),
);
Parameters
$serviceUuid: string — Service UUID
$addressName: string — Address identifier
$address: string — Floating IP address to assign to the service address.
$client->gateway->releaseGatewayFloatingIp($serviceUuid, $addressName)
Description
Release the user-provisioned Floating IP of an existing service address by given {service-address-identifier}, reverting it to a service-provisioned address while keeping the same name.
Usage
$client->gateway->releaseGatewayFloatingIp(
'01234567-89ab-cdef-0123-456789abcdef',
'advanced',
);
Parameters
$serviceUuid: string — Service UUID
$addressName: string — Address identifier
$client->gateway->getGatewayMetrics($serviceUuid) -> GatewayServiceMetricsResponse
Description
List available service metrics for service.
Usage
$client->gateway->getGatewayMetrics(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — Service UUID
$client->gateway->createGatewayServiceLogSession($serviceUuid, $request) -> GatewayServiceLogSessionCreateResponse
Description
Create a new service log session.
Usage
$client->gateway->createGatewayServiceLogSession(
'01234567-89ab-cdef-0123-456789abcdef',
new GatewayServiceLogSessionCreateRequest([
'sessionType' => GatewayServiceLogSessionTypes::Vpn->value,
]),
);
Parameters
$serviceUuid: string — Service UUID
$sessionType: string
load-balancer
$client->loadBalancer->listLoadBalancers($request) -> array
Description
Returns a list of available load balancer services.
Usage
$client->loadBalancer->listLoadBalancers(
new ListLoadBalancersRequest([
'limit' => 10,
'offset' => 0,
]),
);
Parameters
$limit: ?int — Number of entries to receive at most.
$offset: ?int — Offset for retrieved results.
$sort: ?string — Sort resources by field. Prefix with ‘-‘ for descending order.
$label: ?string — Filter resources by label. Can be provided multiple times for multiple labels. Format: ‘key=value’ for exact match or ‘key’ for existence check.
$client->loadBalancer->createLoadBalancer($request) -> LoadBalancerService
Description
Creates a new load balancer service.
Usage
$client->loadBalancer->createLoadBalancer(
new LoadBalancerServiceCreate([
'name' => 'my-loadbalancer',
'zone' => 'fi-hel1',
'plan' => 'production-small',
'configuredStatus' => LoadBalancerServiceConfiguredStatus::Started->value,
'frontends' => [
new LoadBalancerFrontendCreate([
'name' => 'my-frontend',
'port' => 80,
'mode' => LoadBalancerFrontendMode::Http->value,
'defaultBackend' => 'my-backend',
]),
],
]),
);
Parameters
$name: string — Name of the service
$zone: string — Zone
$plan: string — Plan
$configuredStatus: string
$frontends: array — Service frontends
$backends: ?array — Service backends
$resolvers: ?array — Service resolvers
$networkUuid: ?string — Private Network UUID
$networks: ?array — Service networks
$labels: ?array — Labels
$maintenanceDow: ?string
$maintenanceTime: ?string
$ipAddresses: ?array — List of IP addresses for the network
$client->loadBalancer->getLoadBalancer($serviceUuid) -> LoadBalancerService
Description
Returns load balancer service details by given {service-uuid}.
Usage
$client->loadBalancer->getLoadBalancer(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$client->loadBalancer->replaceLoadBalancer($serviceUuid, $request) -> LoadBalancerService
Description
Replaces existing load balancer service by given {service-uuid}.
Usage
$client->loadBalancer->replaceLoadBalancer(
'01234567-89ab-cdef-0123-456789abcdef',
new LoadBalancerServiceReplace([
'name' => 'my-loadbalancer',
'plan' => 'production',
'configuredStatus' => LoadBalancerServiceConfiguredStatus::Started->value,
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$name: string — Name of the service
$plan: string — Plan
$configuredStatus: string
$frontends: ?array — Service frontends
$backends: ?array — Service backends
$resolvers: ?array — Service resolvers
$labels: ?array — Labels
$maintenanceDow: ?string
$maintenanceTime: ?string
$ipAddresses: ?array — List of IP addresses for the network
$client->loadBalancer->deleteLoadBalancer($serviceUuid)
Description
Deletes existing load balancer service by given {service-uuid}.
Usage
$client->loadBalancer->deleteLoadBalancer(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$client->loadBalancer->modifyLoadBalancer($serviceUuid, $request) -> LoadBalancerService
Description
Modifies existing load balancer service by given {service-uuid}.
Usage
$client->loadBalancer->modifyLoadBalancer(
'01234567-89ab-cdef-0123-456789abcdef',
new LoadBalancerServiceModify([
'name' => 'updated-loadbalancer',
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$name: ?string — Name of the service
$plan: ?string — Plan
$configuredStatus: ?string
$frontends: ?array — Service frontends
$backends: ?array — Service backends
$resolvers: ?array — Service resolvers
$labels: ?array — Labels
$maintenanceDow: ?string
$maintenanceTime: ?string
$ipAddresses: ?array — List of IP addresses for the network
$client->loadBalancer->listLoadBalancerFrontends($serviceUuid) -> array
Description
Returns a list of available service frontends by given {service-uuid}.
Usage
$client->loadBalancer->listLoadBalancerFrontends(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$client->loadBalancer->createLoadBalancerFrontend($serviceUuid, $request) -> LoadBalancerFrontend
Description
Creates a new service frontend by given {service-uuid}.
Usage
$client->loadBalancer->createLoadBalancerFrontend(
'01234567-89ab-cdef-0123-456789abcdef',
new CreateLoadBalancerFrontendRequest([
'body' => new LoadBalancerFrontendCreate([
'name' => 'my-frontend',
'port' => 80,
'mode' => LoadBalancerFrontendMode::Http->value,
'defaultBackend' => 'my-backend',
]),
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$request: LoadBalancerFrontendCreate
$client->loadBalancer->getLoadBalancerFrontend($serviceUuid, $frontendName) -> LoadBalancerFrontend
Description
Returns service frontend details by given {service-uuid} and {frontend-name}.
Usage
$client->loadBalancer->getLoadBalancerFrontend(
'01234567-89ab-cdef-0123-456789abcdef',
'example-frontend-1',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$frontendName: string — The unique identifier for the frontend.
$client->loadBalancer->deleteLoadBalancerFrontend($serviceUuid, $frontendName)
Description
Deletes existing frontend by given {service-uuid} and {frontend-name}.
Usage
$client->loadBalancer->deleteLoadBalancerFrontend(
'01234567-89ab-cdef-0123-456789abcdef',
'example-frontend-1',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$frontendName: string — The unique identifier for the frontend.
$client->loadBalancer->modifyLoadBalancerFrontend($serviceUuid, $frontendName, $request) -> LoadBalancerFrontend
Description
Modifies existing service frontend by given {service-uuid} and {frontend-name}.
Usage
$client->loadBalancer->modifyLoadBalancerFrontend(
'01234567-89ab-cdef-0123-456789abcdef',
'example-frontend-1',
new LoadBalancerFrontendModify([
'name' => 'updated-frontend',
'port' => 443,
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$frontendName: string — The unique identifier for the frontend.
$name: ?string — Name of the frontend
$port: ?int — Port to listen
$mode: ?string
$defaultBackend: ?string — Default backend
$properties: ?LoadBalancerFrontendPropertiesCreate
$networks: ?array — Network names
$tlsConfigs: ?array — TLS Configs
$rules: ?array — Rules
$client->loadBalancer->listLoadBalancerFrontendTlsConfigs($serviceUuid, $frontendName) -> array
Description
Returns a list of available frontend TLS configs by given {service-uuid} and {frontend-name}.
Usage
$client->loadBalancer->listLoadBalancerFrontendTlsConfigs(
'01234567-89ab-cdef-0123-456789abcdef',
'example-frontend-1',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$frontendName: string — The unique identifier for the frontend.
$client->loadBalancer->createLoadBalancerFrontendTlsConfig($serviceUuid, $frontendName, $request) -> LoadBalancerTlsConfig
Description
Creates a new TLS config by given {service-uuid} and {frontend-name}.
Usage
$client->loadBalancer->createLoadBalancerFrontendTlsConfig(
'01234567-89ab-cdef-0123-456789abcdef',
'example-frontend-1',
new CreateLoadBalancerFrontendTlsConfigRequest([
'body' => new LoadBalancerTlsConfigCreate([
'name' => 'tls-config-1',
'certificateBundleUuid' => '123e4567-e89b-12d3-a456-426614174000',
]),
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$frontendName: string — The unique identifier for the frontend.
$request: LoadBalancerTlsConfigCreate
$client->loadBalancer->getLoadBalancerFrontendTlsConfig($serviceUuid, $frontendName, $tlsConfigName) -> LoadBalancerTlsConfig
Description
Returns frontend TLS config details by given {service-uuid}, {frontend-name}, and {tls-config-name}.
Usage
$client->loadBalancer->getLoadBalancerFrontendTlsConfig(
'01234567-89ab-cdef-0123-456789abcdef',
'example-frontend-1',
'example-tls-config-1',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$frontendName: string — The unique identifier for the frontend.
$tlsConfigName: string — The unique identifier for the TLS configuration.
$client->loadBalancer->deleteLoadBalancerFrontendTlsConfig($serviceUuid, $frontendName, $tlsConfigName)
Description
Deletes existing TLS config by given {service-uuid}, {frontend-name}, and {tls-config-name}.
Usage
$client->loadBalancer->deleteLoadBalancerFrontendTlsConfig(
'01234567-89ab-cdef-0123-456789abcdef',
'example-frontend-1',
'example-tls-config-1',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$frontendName: string — The unique identifier for the frontend.
$tlsConfigName: string — The unique identifier for the TLS configuration.
$client->loadBalancer->modifyLoadBalancerFrontendTlsConfig($serviceUuid, $frontendName, $tlsConfigName, $request) -> LoadBalancerTlsConfig
Description
Modifies existing TLS config by given {service-uuid}, {frontend-name}, and {tls-config-name}.
Usage
$client->loadBalancer->modifyLoadBalancerFrontendTlsConfig(
'01234567-89ab-cdef-0123-456789abcdef',
'example-frontend-1',
'example-tls-config-1',
new ModifyLoadBalancerFrontendTlsConfigRequest([
'body' => new LoadBalancerTlsConfigModify([
'name' => 'tls-config-1',
'certificateBundleUuid' => '123e4567-e89b-12d3-a456-426614174000',
]),
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$frontendName: string — The unique identifier for the frontend.
$tlsConfigName: string — The unique identifier for the TLS configuration.
$request: LoadBalancerTlsConfigModify
$client->loadBalancer->listLoadBalancerRules($serviceUuid, $frontendName) -> array
Description
Returns a list of available frontend rules by given {service-uuid} and {frontend-name}.
Usage
$client->loadBalancer->listLoadBalancerRules(
'01234567-89ab-cdef-0123-456789abcdef',
'example-frontend-1',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$frontendName: string — The unique identifier for the frontend.
$client->loadBalancer->createLoadBalancerRule($serviceUuid, $frontendName, $request) -> LoadBalancerRule
Description
Creates a new rule by given {service-uuid} and {frontend-name}.
Usage
$client->loadBalancer->createLoadBalancerRule(
'01234567-89ab-cdef-0123-456789abcdef',
'example-frontend-1',
new CreateLoadBalancerRuleRequest([
'body' => new LoadBalancerRuleCreate([
'name' => 'my-rule',
'priority' => 10,
'matchingCondition' => LoadBalancerMatchingCondition::And_->value,
'matchers' => [
new LoadBalancerMatcherCreateMatchSrcIp([
'type' => LoadBalancerMatcherCreateMatchSrcIpType::SrcIp->value,
'matchSrcIp' => new LoadBalancerMatcherIpCreate([
'value' => '192.168.1.1',
]),
]),
],
'actions' => [
new LoadBalancerActionCreateActionUseBackend([
'type' => LoadBalancerActionCreateActionUseBackendType::UseBackend->value,
'actionUseBackend' => new LoadBalancerActionUseBackendCreate([
'backend' => 'backend-1',
]),
]),
],
]),
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$frontendName: string — The unique identifier for the frontend.
$request: LoadBalancerRuleCreate
$client->loadBalancer->getLoadBalancerRule($serviceUuid, $frontendName, $ruleName) -> LoadBalancerRule
Description
Returns frontend rule details by given {service-uuid}, {frontend-name}, and {rule-name}.
Usage
$client->loadBalancer->getLoadBalancerRule(
'01234567-89ab-cdef-0123-456789abcdef',
'example-frontend-1',
'example-rule-1',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$frontendName: string — The unique identifier for the frontend.
$ruleName: string — The unique identifier for the rule.
$client->loadBalancer->replaceLoadBalancerRule($serviceUuid, $frontendName, $ruleName, $request) -> LoadBalancerRule
Description
Replaces existing rule by given {service-uuid}, {frontend-name}, and {rule-name}.
Usage
$client->loadBalancer->replaceLoadBalancerRule(
'01234567-89ab-cdef-0123-456789abcdef',
'example-frontend-1',
'example-rule-1',
new ReplaceLoadBalancerRuleRequest([
'body' => new LoadBalancerRuleCreate([
'name' => 'my-rule',
'priority' => 10,
'matchingCondition' => LoadBalancerMatchingCondition::And_->value,
'matchers' => [
new LoadBalancerMatcherCreateMatchSrcIp([
'type' => LoadBalancerMatcherCreateMatchSrcIpType::SrcIp->value,
'matchSrcIp' => new LoadBalancerMatcherIpCreate([
'value' => '192.168.1.1',
]),
]),
],
'actions' => [
new LoadBalancerActionCreateActionUseBackend([
'type' => LoadBalancerActionCreateActionUseBackendType::UseBackend->value,
'actionUseBackend' => new LoadBalancerActionUseBackendCreate([
'backend' => 'backend-1',
]),
]),
],
]),
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$frontendName: string — The unique identifier for the frontend.
$ruleName: string — The unique identifier for the rule.
$request: LoadBalancerRuleCreate
$client->loadBalancer->deleteLoadBalancerRule($serviceUuid, $frontendName, $ruleName)
Description
Deletes existing rule by given {service-uuid}, {frontend-name}, and {rule-name}.
Usage
$client->loadBalancer->deleteLoadBalancerRule(
'01234567-89ab-cdef-0123-456789abcdef',
'example-frontend-1',
'example-rule-1',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$frontendName: string — The unique identifier for the frontend.
$ruleName: string — The unique identifier for the rule.
$client->loadBalancer->modifyLoadBalancerRule($serviceUuid, $frontendName, $ruleName, $request) -> LoadBalancerRule
Description
Modifies existing rule by given {service-uuid}, {frontend-name}, and {rule-name}.
Usage
$client->loadBalancer->modifyLoadBalancerRule(
'01234567-89ab-cdef-0123-456789abcdef',
'example-frontend-1',
'example-rule-1',
new LoadBalancerRuleModify([
'name' => 'updated-rule',
'priority' => 10,
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$frontendName: string — The unique identifier for the frontend.
$ruleName: string — The unique identifier for the rule.
$name: ?string — Name of the rule
$priority: ?int — Priority
$matchingCondition: ?string
$matchers: ?array — Rule matchers
$actions: ?array — Rule actions
$client->loadBalancer->listLoadBalancerBackends($serviceUuid) -> array
Description
Returns a list of available service backends by given {service-uuid}.
Usage
$client->loadBalancer->listLoadBalancerBackends(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$client->loadBalancer->createLoadBalancerBackend($serviceUuid, $request) -> LoadBalancerBackend
Description
Creates a new backend by given {service-uuid}.
Usage
$client->loadBalancer->createLoadBalancerBackend(
'01234567-89ab-cdef-0123-456789abcdef',
new CreateLoadBalancerBackendRequest([
'body' => new LoadBalancerBackendCreate([
'name' => 'my-backend',
'members' => [
new LoadBalancerMemberCreateZero([
'type' => LoadBalancerMemberCreateZeroType::Static_->value,
'ip' => 'ip',
'port' => 1,
]),
],
]),
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$request: LoadBalancerBackendCreate
$client->loadBalancer->getLoadBalancerBackend($serviceUuid, $backendName) -> LoadBalancerBackend
Description
Returns service backend details by given {service-uuid} and {backend-name}.
Usage
$client->loadBalancer->getLoadBalancerBackend(
'01234567-89ab-cdef-0123-456789abcdef',
'backend-infra',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$backendName: string — The unique identifier for the backend.
$client->loadBalancer->deleteLoadBalancerBackend($serviceUuid, $backendName)
Description
Deletes existing backend by given {service-uuid} and {backend-name}.
Usage
$client->loadBalancer->deleteLoadBalancerBackend(
'01234567-89ab-cdef-0123-456789abcdef',
'backend-infra',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$backendName: string — The unique identifier for the backend.
$client->loadBalancer->modifyLoadBalancerBackend($serviceUuid, $backendName, $request) -> LoadBalancerBackend
Description
Modifies existing backend by given {service-uuid} and {backend-name}.
Usage
$client->loadBalancer->modifyLoadBalancerBackend(
'01234567-89ab-cdef-0123-456789abcdef',
'backend-infra',
new LoadBalancerBackendModify([
'name' => 'updated-backend',
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$backendName: string — The unique identifier for the backend.
$name: ?string — Name of the backend
$members: ?array — Backend members
$tlsConfigs: ?array — TLS Configs
$resolver: ?string — Resolver reference
$properties: ?LoadBalancerBackendPropertiesCreate
$client->loadBalancer->listLoadBalancerMembers($serviceUuid, $backendName) -> array
Description
Returns a list of available backend members by given {service-uuid} and {backend-name}.
Usage
$client->loadBalancer->listLoadBalancerMembers(
'01234567-89ab-cdef-0123-456789abcdef',
'backend-infra',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$backendName: string — The unique identifier for the backend.
$client->loadBalancer->createLoadBalancerMember($serviceUuid, $backendName, $request) -> LoadBalancerMember
Description
Creates a new member by given {service-uuid} and {backend-name}.
Usage
$client->loadBalancer->createLoadBalancerMember(
'01234567-89ab-cdef-0123-456789abcdef',
'backend-infra',
new CreateLoadBalancerMemberRequest([
'body' => new LoadBalancerMemberCreateZero([
'type' => LoadBalancerMemberCreateZeroType::Static_->value,
'ip' => 'ip',
'port' => 1,
]),
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$backendName: string — The unique identifier for the backend.
$request: LoadBalancerMemberCreateZero|LoadBalancerMemberCreateOne
$client->loadBalancer->getLoadBalancerMember($serviceUuid, $backendName, $memberName) -> LoadBalancerMember
Description
Returns backend member details by given {service-uuid}, {backend-name} and {member-name}.
Usage
$client->loadBalancer->getLoadBalancerMember(
'01234567-89ab-cdef-0123-456789abcdef',
'backend-infra',
'dev-member',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$backendName: string — The unique identifier for the backend.
$memberName: string — The unique identifier for the member.
$client->loadBalancer->deleteLoadBalancerMember($serviceUuid, $backendName, $memberName)
Description
Deletes existing member by given {service-uuid}, {backend-name} and {member-name}.
Usage
$client->loadBalancer->deleteLoadBalancerMember(
'01234567-89ab-cdef-0123-456789abcdef',
'backend-infra',
'dev-member',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$backendName: string — The unique identifier for the backend.
$memberName: string — The unique identifier for the member.
$client->loadBalancer->modifyLoadBalancerMember($serviceUuid, $backendName, $memberName, $request) -> LoadBalancerMember
Description
Modifies existing member by given {service-uuid}, {backend-name} and {member-name}.
Usage
$client->loadBalancer->modifyLoadBalancerMember(
'01234567-89ab-cdef-0123-456789abcdef',
'backend-infra',
'dev-member',
new ModifyLoadBalancerMemberRequest([
'body' => new LoadBalancerMemberModifyZero([]),
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$backendName: string — The unique identifier for the backend.
$memberName: string — The unique identifier for the member.
$request: LoadBalancerMemberModifyZero|LoadBalancerMemberModifyOne
$client->loadBalancer->listLoadBalancerBackendTlsConfigs($serviceUuid, $backendName) -> array
Description
Returns a list of available backend TLS configs by given {service-uuid} and {backend-name}.
Usage
$client->loadBalancer->listLoadBalancerBackendTlsConfigs(
'01234567-89ab-cdef-0123-456789abcdef',
'backend-infra',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$backendName: string — The unique identifier for the backend.
$client->loadBalancer->createLoadBalancerBackendTlsConfig($serviceUuid, $backendName, $request) -> LoadBalancerTlsConfig
Description
Creates a new TLS config by given {service-uuid} and {backend-name}.
Usage
$client->loadBalancer->createLoadBalancerBackendTlsConfig(
'01234567-89ab-cdef-0123-456789abcdef',
'backend-infra',
new CreateLoadBalancerBackendTlsConfigRequest([
'body' => new LoadBalancerTlsConfigCreate([
'name' => 'tls-config-1',
'certificateBundleUuid' => '123e4567-e89b-12d3-a456-426614174000',
]),
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$backendName: string — The unique identifier for the backend.
$request: LoadBalancerTlsConfigCreate
$client->loadBalancer->getLoadBalancerBackendTlsConfig($serviceUuid, $backendName, $tlsConfigName) -> LoadBalancerTlsConfig
Description
Returns backend TLS config details by given {service-uuid}, {backend-name}, and {tls-config-name}.
Usage
$client->loadBalancer->getLoadBalancerBackendTlsConfig(
'01234567-89ab-cdef-0123-456789abcdef',
'backend-infra',
'example-tls-config-1',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$backendName: string — The unique identifier for the backend.
$tlsConfigName: string — The unique identifier for the TLS configuration.
$client->loadBalancer->deleteLoadBalancerBackendTlsConfig($serviceUuid, $backendName, $tlsConfigName)
Description
Deletes existing TLS config by given {service-uuid}, {backend-name}, and {tls-config-name}.
Usage
$client->loadBalancer->deleteLoadBalancerBackendTlsConfig(
'01234567-89ab-cdef-0123-456789abcdef',
'backend-infra',
'example-tls-config-1',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$backendName: string — The unique identifier for the backend.
$tlsConfigName: string — The unique identifier for the TLS configuration.
$client->loadBalancer->modifyLoadBalancerBackendTlsConfig($serviceUuid, $backendName, $tlsConfigName, $request) -> LoadBalancerTlsConfig
Description
Modifies existing TLS config by given {service-uuid}, {backend-name}, and {tls-config-name}.
Usage
$client->loadBalancer->modifyLoadBalancerBackendTlsConfig(
'01234567-89ab-cdef-0123-456789abcdef',
'backend-infra',
'example-tls-config-1',
new ModifyLoadBalancerBackendTlsConfigRequest([
'body' => new LoadBalancerTlsConfigModify([
'name' => 'tls-config-1',
'certificateBundleUuid' => '123e4567-e89b-12d3-a456-426614174000',
]),
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$backendName: string — The unique identifier for the backend.
$tlsConfigName: string — The unique identifier for the TLS configuration.
$request: LoadBalancerTlsConfigModify
$client->loadBalancer->modifyLoadBalancerNetwork($serviceUuid, $networkName, $request) -> LoadBalancerNetwork
Description
Modifies existing service network by given {service-uuid} and {network-name}.
Usage
$client->loadBalancer->modifyLoadBalancerNetwork(
'01234567-89ab-cdef-0123-456789abcdef',
'example-network-1',
new LoadBalancerNetworkModify([
'name' => 'updated-network',
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$networkName: string — The unique identifier for the network.
$name: ?string — Name of the network
$client->loadBalancer->listLoadBalancerIpAddresses($serviceUuid) -> array
Description
Returns a list of available IP addresses by given {service-uuid}.
Usage
$client->loadBalancer->listLoadBalancerIpAddresses(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$client->loadBalancer->createLoadBalancerIpAddress($serviceUuid, $request) -> LoadBalancerIpAddress
Description
Attach a floating public IPv4 address to the service using the specified {service-uuid}. The number of attachable floating IPv4 addresses is limited to the number of nodes in the plan, and all addresses must be in the same zone as the service and detached.
Note: Floating public IPv4 addresses have configurable release policies. When the service is deleted or an IP address is detached, addresses with the keep policy will be converted to detached floating IPs that remain available in your account. Addresses with the release policy will be automatically deleted. For more details, see IP Addresses.
Usage
$client->loadBalancer->createLoadBalancerIpAddress(
'01234567-89ab-cdef-0123-456789abcdef',
new CreateLoadBalancerIpAddressRequest([
'body' => new LoadBalancerIpAddressCreate([
'address' => '192.168.1.10',
'networkName' => 'private-net-1',
]),
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$request: LoadBalancerIpAddressCreate
$client->loadBalancer->getLoadBalancerIpAddress($serviceUuid, $ipAddress) -> array
Description
Returns IP address details by given {service-uuid} and {ip-address}.
Usage
$client->loadBalancer->getLoadBalancerIpAddress(
'01234567-89ab-cdef-0123-456789abcdef',
'192.168.1.1',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$ipAddress: string — The unique identifier for the IP address.
$client->loadBalancer->deleteLoadBalancerIpAddress($serviceUuid, $ipAddress)
Description
Detach a floating public IPv4 address from the service by given {service-uuid} and {address}. Depending on the release policy, the customer retains the floating IP if the policy is set to keep. If the policy is set to release, the floating IP will be deleted.
Usage
$client->loadBalancer->deleteLoadBalancerIpAddress(
'01234567-89ab-cdef-0123-456789abcdef',
'192.168.1.1',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$ipAddress: string — The unique identifier for the IP address.
$client->loadBalancer->listLoadBalancerResolvers($serviceUuid) -> array
Description
Returns a list of available service domain name resolvers by given {service-uuid}.
Usage
$client->loadBalancer->listLoadBalancerResolvers(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$client->loadBalancer->createLoadBalancerResolver($serviceUuid, $request) -> LoadBalancerResolver
Description
Creates a new resolver by given {service-uuid}.
Resolver is a DNS server usually residing in a user’s private network. It’s used to resolve IPs for backend members of type dynamic.
Usage
$client->loadBalancer->createLoadBalancerResolver(
'01234567-89ab-cdef-0123-456789abcdef',
new CreateLoadBalancerResolverRequest([
'body' => new LoadBalancerResolverCreate([
'name' => 'default-resolver',
'nameservers' => [
'1.1.1.1:53',
'8.8.8.8:53',
],
'retries' => 3,
'timeout' => 5,
'timeoutRetry' => 3,
'cacheValid' => 300,
'cacheInvalid' => 60,
]),
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$request: LoadBalancerResolverCreate
$client->loadBalancer->getLoadBalancerResolver($serviceUuid, $resolverName) -> LoadBalancerResolver
Description
Returns backend resolver details by given {service-uuid} and {resolver-name}.
Usage
$client->loadBalancer->getLoadBalancerResolver(
'01234567-89ab-cdef-0123-456789abcdef',
'example-resolver-1',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$resolverName: string — The unique identifier for the resolver.
$client->loadBalancer->deleteLoadBalancerResolver($serviceUuid, $resolverName)
Description
Deletes existing resolver by given {service-uuid} and {resolver-name}.
Usage
$client->loadBalancer->deleteLoadBalancerResolver(
'01234567-89ab-cdef-0123-456789abcdef',
'example-resolver-1',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$resolverName: string — The unique identifier for the resolver.
$client->loadBalancer->modifyLoadBalancerResolver($serviceUuid, $resolverName, $request) -> LoadBalancerResolver
Description
Modifies existing resolver by given {service-uuid} and {resolver-name}.
Usage
$client->loadBalancer->modifyLoadBalancerResolver(
'01234567-89ab-cdef-0123-456789abcdef',
'example-resolver-1',
new LoadBalancerResolverModify([
'name' => 'default-resolver',
'nameservers' => [
'1.1.1.1:53',
'8.8.8.8:53',
],
'retries' => 3,
'timeout' => 5,
'timeoutRetry' => 3,
'cacheValid' => 300,
'cacheInvalid' => 60,
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$resolverName: string — The unique identifier for the resolver.
$name: ?string — Name of the resolver
$nameservers: ?array — Nameservers
$retries: ?int — Number of retries on failure
$timeout: ?int — Timeout for the query in seconds
$timeoutRetry: ?int — Timeout for the query retries in seconds
$cacheValid: ?int — Time in seconds to cache valid results
$cacheInvalid: ?int — Time in seconds to cache invalid results
$client->loadBalancer->listLoadBalancerLabels($serviceUuid) -> array
Description
Returns a list of available service labels by given {service-uuid}.
Usage
$client->loadBalancer->listLoadBalancerLabels(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$client->loadBalancer->createLoadBalancerLabel($serviceUuid, $request) -> LoadBalancerLabelResponse
Description
Creates a new label by given {service-uuid}.
Labels used for service filtering.
Service labels usage examples Below are some examples of what certain GET requests might look like.
exact match: GET /1.3/load-balancer?label=env%3Dstaging existence: GET /1.3/load-balancer?label=env multiple: GET /1.3/load-balancer?label=env&label=foo%3Dbar
Usage
$client->loadBalancer->createLoadBalancerLabel(
'01234567-89ab-cdef-0123-456789abcdef',
new CreateLoadBalancerLabelRequest([
'body' => new LoadBalancerLabelCreate([
'key' => 'environment',
'value' => 'production',
]),
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$request: LoadBalancerLabelCreate
$client->loadBalancer->getLoadBalancerLabel($serviceUuid, $labelKey) -> LoadBalancerLabelResponse
Description
Returns label details by given {service-uuid} and {label-key}.
Usage
$client->loadBalancer->getLoadBalancerLabel(
'01234567-89ab-cdef-0123-456789abcdef',
'example-key-1',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$labelKey: string — The unique identifier for the label.
$client->loadBalancer->deleteLoadBalancerLabel($serviceUuid, $labelKey)
Description
Deletes existing label by given {service-uuid} and {label-key}.
Usage
$client->loadBalancer->deleteLoadBalancerLabel(
'01234567-89ab-cdef-0123-456789abcdef',
'example-key-1',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$labelKey: string — The unique identifier for the label.
$client->loadBalancer->modifyLoadBalancerLabel($serviceUuid, $labelKey, $request) -> LoadBalancerLabelResponse
Description
Modifies existing label by given {service-uuid} and {label-key}.
Usage
$client->loadBalancer->modifyLoadBalancerLabel(
'01234567-89ab-cdef-0123-456789abcdef',
'example-key-1',
new ModifyLoadBalancerLabelRequest([
'body' => new LoadBalancerLabelModify([
'key' => 'environment',
'value' => 'production',
]),
]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$labelKey: string — The unique identifier for the label.
$request: LoadBalancerLabelModify
$client->loadBalancer->getLoadBalancerMetrics($serviceUuid) -> LoadBalancerMetrics
Description
Returns service metrics by given {service-uuid}.
Usage
$client->loadBalancer->getLoadBalancerMetrics(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$client->loadBalancer->getLoadBalancerMetricsSeries($serviceUuid) -> array
Description
Returns service metric series by given {service-uuid}.
Usage
$client->loadBalancer->getLoadBalancerMetricsSeries(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$client->loadBalancer->getLoadBalancerFrontendCombinedMetricsSeries($serviceUuid, $request) -> array
Description
Returns combined frontend metric series by given {service-uuid}.
Usage
$client->loadBalancer->getLoadBalancerFrontendCombinedMetricsSeries(
'01234567-89ab-cdef-0123-456789abcdef',
new GetLoadBalancerFrontendCombinedMetricsSeriesRequest([]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$sort: ?string — Sort metrics by field. Prefix with ‘-‘ for descending order.
$client->loadBalancer->getLoadBalancerFrontendMetricsSeries($serviceUuid, $frontendName, $request) -> array
Description
Returns frontend metric series by given {service-uuid} and {frontend-name}.
Usage
$client->loadBalancer->getLoadBalancerFrontendMetricsSeries(
'01234567-89ab-cdef-0123-456789abcdef',
'example-frontend-1',
new GetLoadBalancerFrontendMetricsSeriesRequest([]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$frontendName: string — The unique identifier for the frontend.
$sort: ?string — Sort metrics by field. Prefix with ‘-‘ for descending order.
$client->loadBalancer->getLoadBalancerBackendCombinedMetricsSeries($serviceUuid, $request) -> array
Description
Returns combined backend metric series by given {service-uuid}.
Usage
$client->loadBalancer->getLoadBalancerBackendCombinedMetricsSeries(
'01234567-89ab-cdef-0123-456789abcdef',
new GetLoadBalancerBackendCombinedMetricsSeriesRequest([]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$sort: ?string — Sort metrics by field. Prefix with ‘-‘ for descending order.
$client->loadBalancer->getLoadBalancerBackendMetricsSeries($serviceUuid, $backendName, $request) -> array
Description
Returns backend metric series by given {service-uuid} and {backend-name}.
Usage
$client->loadBalancer->getLoadBalancerBackendMetricsSeries(
'01234567-89ab-cdef-0123-456789abcdef',
'backend-infra',
new GetLoadBalancerBackendMetricsSeriesRequest([]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$backendName: string — The unique identifier for the backend.
$sort: ?string — Sort metrics by field. Prefix with ‘-‘ for descending order.
$client->loadBalancer->getLoadBalancerMemberCombinedMetricsSeries($serviceUuid, $backendName, $request) -> LoadBalancerMemberMetricsSeriesResponse
Description
Returns combined backend members metric series by given {service-uuid} and {backend-name}.
Usage
$client->loadBalancer->getLoadBalancerMemberCombinedMetricsSeries(
'01234567-89ab-cdef-0123-456789abcdef',
'backend-infra',
new GetLoadBalancerMemberCombinedMetricsSeriesRequest([]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$backendName: string — The unique identifier for the backend.
$sort: ?string — Sort metrics by field. Prefix with ‘-‘ for descending order.
$client->loadBalancer->getLoadBalancerMemberMetricsSeries($serviceUuid, $backendName, $memberName, $request) -> LoadBalancerMemberMetricsSeriesResponse
Description
Returns backend member metric series by given {service-uuid}, {backend-name}, and {member-name}.
Usage
$client->loadBalancer->getLoadBalancerMemberMetricsSeries(
'01234567-89ab-cdef-0123-456789abcdef',
'backend-infra',
'dev-member',
new GetLoadBalancerMemberMetricsSeriesRequest([]),
);
Parameters
$serviceUuid: string — The unique identifier for the service.
$backendName: string — The unique identifier for the backend.
$memberName: string — The unique identifier for the member.
$sort: ?string — Sort metrics by field. Prefix with ‘-‘ for descending order.
$client->loadBalancer->listLoadBalancerCertificateBundles($request) -> array
Description
Returns a list of available certificate bundles.
Usage
$client->loadBalancer->listLoadBalancerCertificateBundles(
new ListLoadBalancerCertificateBundlesRequest([
'limit' => 10,
'offset' => 0,
]),
);
Parameters
$limit: ?int — Number of entries to receive at most.
$offset: ?int — Offset for retrieved results.
$label: ?string — Filter resources by label. Can be provided multiple times for multiple labels. Format: ‘key=value’ for exact match or ‘key’ for existence check.
$client->loadBalancer->createLoadBalancerCertificateBundle($request) -> LoadBalancerCertificateBundle
Description
Creates a new certificate bundle.
Usage
$client->loadBalancer->createLoadBalancerCertificateBundle(
new LoadBalancerCertificateBundleCreateZero([
'type' => LoadBalancerCertificateBundleCreateZeroType::Manual->value,
]),
);
Parameters
$request: LoadBalancerCertificateBundleCreateZero|LoadBalancerCertificateBundleCreateCertificate|LoadBalancerCertificateBundleCreateType
$client->loadBalancer->getLoadBalancerCertificateBundle($bundleUuid) -> LoadBalancerCertificateBundle
Description
Returns certificate bundle details by given {bundle-uuid}.
Usage
$client->loadBalancer->getLoadBalancerCertificateBundle(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$bundleUuid: string — The unique identifier for the certificate bundle.
$client->loadBalancer->deleteLoadBalancerCertificateBundle($bundleUuid)
Description
Deletes existing certificate bundle by given {bundle-uuid}.
Usage
$client->loadBalancer->deleteLoadBalancerCertificateBundle(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$bundleUuid: string — The unique identifier for the certificate bundle.
$client->loadBalancer->modifyLoadBalancerCertificateBundle($bundleUuid, $request) -> LoadBalancerCertificateBundle
Description
Modifies existing a manual, dynamic or authority certificate bundle by given {bundle-uuid}.
Usage
$client->loadBalancer->modifyLoadBalancerCertificateBundle(
'01234567-89ab-cdef-0123-456789abcdef',
new ModifyLoadBalancerCertificateBundleRequest([
'body' => new LoadBalancerCertificateBundleManualModify([
'name' => 'updated-manual-cert',
]),
]),
);
Parameters
$bundleUuid: string — The unique identifier for the certificate bundle.
$request: LoadBalancerCertificateBundleManualModify|LoadBalancerCertificateBundleDynamicModify|LoadBalancerCertificateBundleAuthorityModify
$client->loadBalancer->listLoadBalancerCertificateBundleLabels($bundleUuid) -> array
Description
Returns a list of available certificate bundle labels by given {bundle-uuid}.
Usage
$client->loadBalancer->listLoadBalancerCertificateBundleLabels(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$bundleUuid: string — The unique identifier for the certificate bundle.
$client->loadBalancer->createLoadBalancerCertificateBundleLabel($bundleUuid, $request) -> LoadBalancerLabelResponse
Description
Creates a new label by given {bundle-uuid}.
Labels used for certificate bundles filtering.
Certificate bundle labels usage examples Below are some examples of what certain GET requests might look like.
exact match: GET /1.3/load-balancer/certificate-bundles?label=env%3Dstaging existence: GET /1.3/load-balancer/certificate-bundles?label=env multiple: GET /1.3/load-balancer/certificate-bundles?label=env&label=foo%3Dbar
Usage
$client->loadBalancer->createLoadBalancerCertificateBundleLabel(
'01234567-89ab-cdef-0123-456789abcdef',
new CreateLoadBalancerCertificateBundleLabelRequest([
'body' => new LoadBalancerLabelCreate([
'key' => 'environment',
'value' => 'production',
]),
]),
);
Parameters
$bundleUuid: string — The unique identifier for the certificate bundle.
$request: LoadBalancerLabelCreate
$client->loadBalancer->getLoadBalancerCertificateBundleLabel($bundleUuid, $labelKey) -> LoadBalancerLabelResponse
Description
Returns label details by given {bundle-uuid} and {label-key}.
Usage
$client->loadBalancer->getLoadBalancerCertificateBundleLabel(
'01234567-89ab-cdef-0123-456789abcdef',
'example-key-1',
);
Parameters
$bundleUuid: string — The unique identifier for the certificate bundle.
$labelKey: string — The unique identifier for the label.
$client->loadBalancer->deleteLoadBalancerCertificateBundleLabel($bundleUuid, $labelKey)
Description
Deletes existing label by given {bundle-uuid} and {label-key}.
Usage
$client->loadBalancer->deleteLoadBalancerCertificateBundleLabel(
'01234567-89ab-cdef-0123-456789abcdef',
'example-key-1',
);
Parameters
$bundleUuid: string — The unique identifier for the certificate bundle.
$labelKey: string — The unique identifier for the label.
$client->loadBalancer->modifyLoadBalancerCertificateBundleLabel($bundleUuid, $labelKey, $request) -> LoadBalancerLabelResponse
Description
Modifies existing label by given {bundle-uuid} and {label-key}.
Usage
$client->loadBalancer->modifyLoadBalancerCertificateBundleLabel(
'01234567-89ab-cdef-0123-456789abcdef',
'example-key-1',
new ModifyLoadBalancerCertificateBundleLabelRequest([
'body' => new LoadBalancerLabelModify([
'key' => 'environment',
'value' => 'production',
]),
]),
);
Parameters
$bundleUuid: string — The unique identifier for the certificate bundle.
$labelKey: string — The unique identifier for the label.
$request: LoadBalancerLabelModify
$client->loadBalancer->getLoadBalancerDnsChallengeDomain() -> LoadBalancerDnsChallengeDomainResponse
Description
Returns DNS challenge domain.
This can be used to validate domain ownership using the ACME challenge method. To validate your domain, you need to add CNAME record to the domain provided by this API to your DNS settings. The name/host of the CNAME record should be _acme-challenge or _acme-challenge.mysubdomain if you are setting up a subdomain called mysubdomain. The target/points to of the record needs to be set to the value returned by this API.
Usage
$client->loadBalancer->getLoadBalancerDnsChallengeDomain();
$client->loadBalancer->listLoadBalancerPlans($request) -> array
Description
Returns a list of available load balancer plans.
Usage
$client->loadBalancer->listLoadBalancerPlans(
new ListLoadBalancerPlansRequest([
'limit' => 10,
'offset' => 0,
]),
);
Parameters
$limit: ?int — Number of entries to receive at most.
$offset: ?int — Offset for retrieved results.
$client->loadBalancer->getLoadBalancerPlan($planName) -> LoadBalancerPlan
Description
Returns load balancer plan details by given {plan-name}.
Usage
$client->loadBalancer->getLoadBalancerPlan(
'example-plan-1',
);
Parameters
$planName: string — The unique identifier for the plan.
firewall-ruleset
$client->firewallRuleset->listFirewallRulesets($request) -> array
Description
Returns a list of firewall rulesets.
Usage
$client->firewallRuleset->listFirewallRulesets(
new ListFirewallRulesetsRequest([
'limit' => 10,
'offset' => 0,
'sort' => 'name',
]),
);
Parameters
$limit: ?int — Number of entries to receive at most.
$offset: ?int — Offset for retrieved results.
$sort: ?string — Order of returned results.
$client->firewallRuleset->createFirewallRuleset($request) -> FirewallRulesetDetailResponse
Description
Creates a new firewall ruleset.
Usage
$client->firewallRuleset->createFirewallRuleset(
new CreateFirewallRuleset([
'name' => 'example_firewall_ruleset',
'stateful' => true,
'enabled' => false,
'defaultDnsRulesEnabled' => false,
]),
);
Parameters
$name: string — Name of the firewall ruleset
$description: ?string — Description of the firewall ruleset
$stateful: ?bool
$enabled: ?bool
$defaultDnsRulesEnabled: ?bool
$labels: ?array — Labels
$client->firewallRuleset->getFirewallRuleset($rulesetUuid) -> FirewallRulesetDetailResponse
Description
Returns firewall ruleset details by given {ruleset-uuid}.
Usage
$client->firewallRuleset->getFirewallRuleset(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$rulesetUuid: string — Firewall ruleset UUID
$client->firewallRuleset->deleteFirewallRuleset($rulesetUuid)
Description
Deletes existing firewall ruleset by given {ruleset-uuid}.
Usage
$client->firewallRuleset->deleteFirewallRuleset(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$rulesetUuid: string — Firewall ruleset UUID
$client->firewallRuleset->modifyFirewallRuleset($rulesetUuid, $request) -> FirewallRulesetDetailResponse
Description
Modifies existing firewall ruleset by given {ruleset-uuid}.
Usage
$client->firewallRuleset->modifyFirewallRuleset(
'01234567-89ab-cdef-0123-456789abcdef',
new FirewallRulesetModify([
'name' => 'modified_example_firewall_ruleset',
'description' => 'Modified example stateless firewall ruleset',
'labels' => [
new FirewallRulesetCreateLabel([
'key' => 'dev',
'value' => 'dev-1',
]),
],
'enabled' => false,
]),
);
Parameters
$rulesetUuid: string — Firewall ruleset UUID
$name: ?string — Name of the ruleset
$description: ?string — Description of the firewall ruleset
$labels: ?array — Labels
$enabled: ?bool — Enabled
$defaultDnsRulesEnabled: ?bool
$client->firewallRuleset->restoreFirewallRuleset($rulesetUuid, $rulesetVersion) -> FirewallRulesetDetailResponse
Description
Restores existing firewall ruleset by given {ruleset-uuid} and {ruleset-version}.
Usage
$client->firewallRuleset->restoreFirewallRuleset(
'01234567-89ab-cdef-0123-456789abcdef',
1,
);
Parameters
$rulesetUuid: string — Firewall ruleset UUID
$rulesetVersion: int — Firewall ruleset version
$client->firewallRuleset->listFirewallRulesetRules($rulesetUuid, $request) -> FirewallRulesetFirewallRuleListResponse
Description
Returns firewall ruleset rules.
Usage
$client->firewallRuleset->listFirewallRulesetRules(
'01234567-89ab-cdef-0123-456789abcdef',
new ListFirewallRulesetRulesRequest([
'limit' => 10,
'offset' => 0,
'sort' => 'name',
]),
);
Parameters
$rulesetUuid: string — Firewall ruleset UUID
$limit: ?int — Number of entries to receive at most.
$offset: ?int — Offset for retrieved results.
$sort: ?string — Order of returned results.
$client->firewallRuleset->createFirewallRulesetRule($rulesetUuid, $request) -> FirewallRulesetRuleDetailResponse
Description
Creates a new firewall ruleset rule by the given {ruleset-uuid}.
Usage
$client->firewallRuleset->createFirewallRulesetRule(
'01234567-89ab-cdef-0123-456789abcdef',
new CreateFirewallRulesetRuleRequest([
'body' => new FirewallRulesetFirewallRuleCreate([
'enabled' => false,
'action' => FirewallRulesetRuleAction::Accept->value,
'direction' => FirewallRulesetRuleDirection::In->value,
'family' => FirewallRulesetRuleFamily::IPv4->value,
'protocol' => FirewallRulesetRuleProtocol::Tcp->value,
]),
]),
);
Parameters
$rulesetUuid: string — Firewall ruleset UUID
$request: FirewallRulesetFirewallRuleCreate
$client->firewallRuleset->createMultipleFirewallRulesetRule($rulesetUuid, $request) -> FirewallRulesetFirewallRuleListResponse
Description
Creates multiple firewall ruleset rules by the given {ruleset-uuid}.
Usage
$client->firewallRuleset->createMultipleFirewallRulesetRule(
'01234567-89ab-cdef-0123-456789abcdef',
new FirewallRulesetFirewallMultipleRuleCreate([
'rules' => [
new FirewallRulesetFirewallRuleCreate([
'enabled' => false,
'action' => FirewallRulesetRuleAction::Accept->value,
'direction' => FirewallRulesetRuleDirection::In->value,
'family' => FirewallRulesetRuleFamily::IPv4->value,
'protocol' => FirewallRulesetRuleProtocol::Tcp->value,
]),
],
]),
);
Parameters
$rulesetUuid: string — Firewall ruleset UUID
$rules: array
$client->firewallRuleset->getFirewallRulesetRule($rulesetUuid, $ruleId) -> FirewallRulesetRuleDetailResponse
Description
Returns firewall ruleset rule details.
Usage
$client->firewallRuleset->getFirewallRulesetRule(
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$rulesetUuid: string — Firewall ruleset UUID
$ruleId: string — Firewall ruleset rule UUID
$client->firewallRuleset->deleteFirewallRulesetRule($rulesetUuid, $ruleId)
Description
Deletes an existing rule by given {ruleset-uuid} and {rule-uuid}.
Usage
$client->firewallRuleset->deleteFirewallRulesetRule(
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$rulesetUuid: string — Firewall ruleset UUID
$ruleId: string — Firewall ruleset rule UUID
$client->firewallRuleset->modifyFirewallRulesetRule($rulesetUuid, $ruleId, $request) -> FirewallRulesetRuleDetailResponse
Description
Modifies existing firewall ruleset rule by given {ruleset_uuid} and {rule-uuid}.
Usage
$client->firewallRuleset->modifyFirewallRulesetRule(
'01234567-89ab-cdef-0123-456789abcdef',
'01234567-89ab-cdef-0123-456789abcdef',
new FirewallRulesetFirewallRuleModify([
'enabled' => false,
'action' => FirewallRulesetRuleAction::Accept->value,
'direction' => FirewallRulesetRuleDirection::In->value,
'family' => FirewallRulesetRuleFamily::IPv4->value,
'protocol' => FirewallRulesetRuleProtocol::Tcp->value,
]),
);
Parameters
$rulesetUuid: string — Firewall ruleset UUID
$ruleId: string — Firewall ruleset rule UUID
$enabled: ?bool — Enabled
$action: ?string
$comment: ?string — Comments
$destinationAddressStart: ?string
$destinationAddressEnd: ?string
$destinationPortStart: ?int
$destinationPortEnd: ?int
$destinationAddressCidr: ?string
$direction: ?string
$family: ?string
$icmpType: ?int
$position: ?int
$protocol: ?string
$sourceAddressStart: ?string
$sourceAddressEnd: ?string
$sourcePortStart: ?int
$sourcePortEnd: ?int
$sourceAddressCidr: ?string
$client->firewallRuleset->listFirewallRulesetLabels($rulesetUuid) -> array
Description
Returns a list of available firewall ruleset labels by given {ruleset-uuid}.
Usage
$client->firewallRuleset->listFirewallRulesetLabels(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$rulesetUuid: string — Firewall ruleset UUID
$client->firewallRuleset->createFirewallRulesetLabel($rulesetUuid, $request) -> FirewallRulesetLabelDetailResponse
Description
Creates a new label by given {ruleset-uuid}. Labels are used for group filtering.
Usage
$client->firewallRuleset->createFirewallRulesetLabel(
'01234567-89ab-cdef-0123-456789abcdef',
new CreateFirewallRulesetLabelRequest([
'body' => new FirewallRulesetCreateLabel([
'key' => 'dev',
'value' => 'dev-1',
]),
]),
);
Parameters
$rulesetUuid: string — Firewall ruleset UUID
$request: FirewallRulesetCreateLabel
$client->firewallRuleset->listFirewallRulesetAttachedServers($rulesetUuid) -> array
Description
Returns a list of servers that are attached to the firewall ruleset by given {ruleset-uuid}.
Usage
$client->firewallRuleset->listFirewallRulesetAttachedServers(
'01234567-89ab-cdef-0123-456789abcdef',
);
Parameters
$rulesetUuid: string — Firewall ruleset UUID
$client->firewallRuleset->getFirewallRulesetLabel($rulesetUuid, $labelKey) -> FirewallRulesetLabelDetailResponse
Description
Returns label details by given {ruleset-uuid} and {label-key}.
Usage
$client->firewallRuleset->getFirewallRulesetLabel(
'01234567-89ab-cdef-0123-456789abcdef',
'environment',
);
Parameters
$rulesetUuid: string — Firewall ruleset UUID
$labelKey: string — The key of the label.
$client->firewallRuleset->deleteFirewallRulesetLabel($rulesetUuid, $labelKey)
Description
Deletes existing label by given {ruleset-uuid} and {label-key}.
Usage
$client->firewallRuleset->deleteFirewallRulesetLabel(
'01234567-89ab-cdef-0123-456789abcdef',
'environment',
);
Parameters
$rulesetUuid: string — Firewall ruleset UUID
$labelKey: string — The key of the label.
$client->firewallRuleset->modifyFirewallRulesetLabel($rulesetUuid, $labelKey, $request) -> FirewallRulesetLabelDetailResponse
Description
Modifies existing label by given {ruleset-uuid} and {label-key}.
Usage
$client->firewallRuleset->modifyFirewallRulesetLabel(
'01234567-89ab-cdef-0123-456789abcdef',
'environment',
new FirewallRulesetLabelModify([
'key' => 'foo',
'value' => 'bar',
]),
);
Parameters
$rulesetUuid: string — Firewall ruleset UUID
$labelKey: string — The key of the label.
$key: ?string
$value: ?string
$client->firewallRuleset->listServerFirewallRule($serverUuid, $request) -> FirewallRulesetServerFirewallDetailResponse
Description
Returns a list of server firewall rules.
Usage
$client->firewallRuleset->listServerFirewallRule(
'01234567-89ab-cdef-0123-456789abcdef',
new ListServerFirewallRuleRequest([
'limit' => 10,
'offset' => 0,
'sort' => 'name',
]),
);
Parameters
$serverUuid: string — Server UUID
$limit: ?int — Number of entries to receive at most.
$offset: ?int — Offset for retrieved results.
$sort: ?string — Order of returned results.
$client->firewallRuleset->createServerFirewallRule($serverUuid, $request) -> FirewallRulesetServerFirewallRuleDetail
Description
Creates a new server firewall rule.
Usage
$client->firewallRuleset->createServerFirewallRule(
'01234567-89ab-cdef-0123-456789abcdef',
new FirewallRulesetServerFirewallRuleCreate([
'firewallRule' => new FirewallRulesetServerFirewallRule([
'direction' => FirewallRulesetRuleDirection::In->value,
'action' => FirewallRulesetRuleAction::Accept->value,
'family' => 'IPv4',
'protocol' => 'tcp',
'destinationAddressStart' => '',
'destinationAddressEnd' => '',
'sourceAddressStart' => '192.168.1.1',
'sourceAddressEnd' => '192.168.1.255',
'comment' => 'Allow SSH from this network',
]),
]),
);
Parameters
$serverUuid: string — Server UUID
$firewallRule: FirewallRulesetServerFirewallRule
$client->firewallRuleset->createMultipleServerFirewallRules($serverUuid, $request) -> FirewallRulesetServerFirewallDetailResponse
Description
Creates multiple server firewall rules by given {server-uuid}.
Usage
$client->firewallRuleset->createMultipleServerFirewallRules(
'01234567-89ab-cdef-0123-456789abcdef',
new FirewallRulesetServerMultipleFirewallRulesCreate([
'firewallRules' => new FirewallRulesetServerMultipleFirewallRulesCreateFirewallRules([
'firewallRule' => [
new FirewallRulesetServerFirewallRule([
'direction' => FirewallRulesetRuleDirection::In->value,
'action' => FirewallRulesetRuleAction::Accept->value,
'family' => 'IPv4',
'protocol' => 'tcp',
'sourceAddressStart' => '192.168.1.1',
'sourceAddressEnd' => '192.168.1.255',
'comment' => 'Allow SSH from this network',
]),
new FirewallRulesetServerFirewallRule([
'direction' => FirewallRulesetRuleDirection::In->value,
'action' => FirewallRulesetRuleAction::Accept->value,
'family' => 'IPv4',
'protocol' => 'tcp',
'sourceAddressStart' => '1.1.1.1',
'sourceAddressEnd' => '1.1.1.1',
'comment' => 'Allow DNS from this network',
]),
new FirewallRulesetServerFirewallRule([
'direction' => FirewallRulesetRuleDirection::Out->value,
'action' => FirewallRulesetRuleAction::Drop->value,
'family' => 'IPv4',
'protocol' => 'tcp',
'destinationAddressStart' => '100.100.128.2',
'destinationAddressEnd' => '100.100.128.2',
'comment' => 'dfg',
]),
new FirewallRulesetServerFirewallRule([
'direction' => FirewallRulesetRuleDirection::Out->value,
'action' => FirewallRulesetRuleAction::Accept->value,
'family' => 'IPv6',
'protocol' => 'icmp',
'destinationAddressStart' => '2a04:3540:1001:1000:1411:4dff:fea5:1bab',
'destinationAddressEnd' => '2a04:3540:1001:1000:1411:4dff:fea5:1bab',
'comment' => "'w???''?p'2'?12??12?3?'231",
]),
],
]),
]),
);
Parameters
$serverUuid: string — Server UUID
$firewallRules: ?FirewallRulesetServerMultipleFirewallRulesCreateFirewallRules
$client->firewallRuleset->getServerFirewallRule($serverUuid, $position) -> FirewallRulesetServerFirewallRuleDetail
Description
Returns server firewall rule details by given {server-uuid} and {position}.
Usage
$client->firewallRuleset->getServerFirewallRule(
'01234567-89ab-cdef-0123-456789abcdef',
1,
);
Parameters
$serverUuid: string — Server UUID
$position: int|string — Server firewall rule position
$client->firewallRuleset->deleteServerFirewallRule($serverUuid, $position)
Description
Deletes existing server firewall rule by given {server-uuid} and {position}.
Usage
$client->firewallRuleset->deleteServerFirewallRule(
'01234567-89ab-cdef-0123-456789abcdef',
1,
);
Parameters
$serverUuid: string — Server UUID
$position: int|string — Server firewall rule position
vnc_keymap
$client->vncKeymap->listVncKeymaps() -> VncKeymapKeymaps
Description
Retrieves a list of supported VNC keymaps.
Usage
$client->vncKeymap->listVncKeymaps();
zone
$client->zone->listZones() -> Zones
Description
Retrieves a list of zones.
Usage
$client->zone->listZones();
$client->zone->listZoneVlaNs($zone) -> ZoneVlans
Description
Retrieves a list of VLANs in a specific zone.
Usage
$client->zone->listZoneVlaNs(
'fi-hel1',
);
Parameters
$zone: string — The zone identifier.