Initial commit

This commit is contained in:
Pierre Lannoy 2025-02-24 15:03:32 +01:00
commit 1471ce6ba4
Signed by: Pierre Lannoy
GPG key ID: D27231EF87D53F31
546 changed files with 143609 additions and 0 deletions

15
.gitignore vendored Normal file
View file

@ -0,0 +1,15 @@
# ref: https://github.com/github/gitignore/blob/master/Composer.gitignore
composer.phar
/vendor/
# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
# composer.lock
# php-cs-fixer cache
.php_cs.cache
.php-cs-fixer.cache
# PHPUnit cache
.phpunit.result.cache

8
.idea/.gitignore generated vendored Normal file
View file

@ -0,0 +1,8 @@
# Default ignored files
/shelf/
/workspace.xml
# Editor-based HTTP Client requests
/httpRequests/
# Datasource local storage ignored files
/dataSources/
/dataSources.local.xml

8
.idea/Instances.iml generated Normal file
View file

@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="WEB_MODULE" version="4">
<component name="NewModuleRootManager">
<content url="file://$MODULE_DIR$" />
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
</component>
</module>

View file

@ -0,0 +1,34 @@
<component name="InspectionProjectProfileManager">
<profile version="1.0">
<option name="myName" value="Project Default" />
<inspection_tool class="DuplicatedCode" enabled="true" level="WEAK WARNING" enabled_by_default="true">
<Languages>
<language isEnabled="false" name="PHP" />
</Languages>
</inspection_tool>
<inspection_tool class="PhpAssignmentInConditionInspection" enabled="true" level="WARNING" enabled_by_default="true" />
<inspection_tool class="PhpCSFixerValidationInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true">
<option name="CODING_STANDARD" value="PHP71Migration" />
</inspection_tool>
<inspection_tool class="PhpCSValidationInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true">
<option name="CODING_STANDARD" value="WordPress-Extra" />
<option name="USE_INSTALLED_PATHS" value="true" />
<option name="INSTALLED_PATHS" value="$USER_HOME$/Php/wpcs" />
</inspection_tool>
<inspection_tool class="PhpDivisionByZeroInspection" enabled="true" level="WARNING" enabled_by_default="true" />
<inspection_tool class="PhpDocMissingThrowsInspection" enabled="false" level="WEAK WARNING" enabled_by_default="false" />
<inspection_tool class="PhpMethodOrClassCallIsNotCaseSensitiveInspection" enabled="true" level="WARNING" enabled_by_default="true" />
<inspection_tool class="PhpMissingDocCommentInspection" enabled="true" level="WARNING" enabled_by_default="true" />
<inspection_tool class="PhpMissingParentCallCommonInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
<inspection_tool class="PhpMissingParentCallMagicInspection" enabled="true" level="WARNING" enabled_by_default="true" />
<inspection_tool class="PhpMultipleClassesDeclarationsInOneFile" enabled="true" level="WARNING" enabled_by_default="true" />
<inspection_tool class="PhpNonCanonicalElementsOrderInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
<inspection_tool class="PhpStaticAsDynamicMethodCallInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
<inspection_tool class="PhpTraditionalSyntaxArrayLiteralInspection" enabled="true" level="WARNING" enabled_by_default="true" />
<inspection_tool class="PhpUndefinedCallbackInspection" enabled="true" level="WARNING" enabled_by_default="true" />
<inspection_tool class="PhpUnitCoversFunctionWithoutScopeResolutionOperatorInspection" enabled="false" level="WARNING" enabled_by_default="false" />
<inspection_tool class="PhpUnitMissingTargetForTestInspection" enabled="false" level="INFORMATION" enabled_by_default="false" />
<inspection_tool class="PhpUnitUndefinedDataProviderInspection" enabled="false" level="WARNING" enabled_by_default="false" />
<inspection_tool class="PhpVariableVariableInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
</profile>
</component>

6
.idea/misc.xml generated Normal file
View file

@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="GithubDefaultAccount">
<option name="defaultAccountId" value="654854a2-fe4c-4cfe-b9fd-e3da02f7c585" />
</component>
</project>

8
.idea/modules.xml generated Normal file
View file

@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectModuleManager">
<modules>
<module fileurl="file://$PROJECT_DIR$/.idea/Instances.iml" filepath="$PROJECT_DIR$/.idea/Instances.iml" />
</modules>
</component>
</project>

23
.idea/php.xml generated Normal file
View file

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="MessDetectorOptionsConfiguration">
<option name="transferred" value="true" />
</component>
<component name="PHPCSFixerOptionsConfiguration">
<option name="codingStandard" value="PHP71Migration" />
<option name="transferred" value="true" />
</component>
<component name="PHPCodeSnifferOptionsConfiguration">
<option name="codingStandard" value="WordPress-Extra" />
<option name="highlightLevel" value="WARNING" />
<option name="installedPaths" value="$USER_HOME$/Php/wpcs" />
<option name="useInstalledPaths" value="true" />
<option name="transferred" value="true" />
</component>
<component name="PhpStanOptionsConfiguration">
<option name="transferred" value="true" />
</component>
<component name="PsalmOptionsConfiguration">
<option name="transferred" value="true" />
</component>
</project>

6
.idea/vcs.xml generated Normal file
View file

@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="" vcs="Git" />
</component>
</project>

23
.openapi-generator-ignore Normal file
View file

@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.
# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md

535
.openapi-generator/FILES Normal file
View file

@ -0,0 +1,535 @@
.gitignore
.openapi-generator-ignore
.php-cs-fixer.dist.php
.travis.yml
README.md
composer.json
docs/Api/DefaultApi.md
docs/Api/IPsApi.md
docs/Api/ImagesApi.md
docs/Api/InstanceTypesApi.md
docs/Api/InstancesApi.md
docs/Api/PlacementGroupsApi.md
docs/Api/PrivateNICsApi.md
docs/Api/SecurityGroupsApi.md
docs/Api/SnapshotsApi.md
docs/Api/UserDataApi.md
docs/Api/VolumeTypesApi.md
docs/Api/VolumesApi.md
docs/Model/ApplyBlockMigrationRequest.md
docs/Model/AttachServerVolumeRequest.md
docs/Model/CheckBlockMigrationOrganizationQuotasRequest.md
docs/Model/CreateImageRequest.md
docs/Model/CreateImageRequestExtraVolumes.md
docs/Model/CreateIpRequest.md
docs/Model/CreatePlacementGroupRequest.md
docs/Model/CreatePrivateNICRequest.md
docs/Model/CreateSecurityGroupRequest.md
docs/Model/CreateSecurityGroupRuleRequest.md
docs/Model/CreateServerRequest.md
docs/Model/CreateServerRequestVolumes.md
docs/Model/CreateSnapshotRequest.md
docs/Model/CreateVolumeRequest.md
docs/Model/DetachServerVolumeRequest.md
docs/Model/ExportSnapshotRequest.md
docs/Model/PlanBlockMigrationRequest.md
docs/Model/ScalewayInstanceV1Arch.md
docs/Model/ScalewayInstanceV1AttachServerVolumeRequestVolumeType.md
docs/Model/ScalewayInstanceV1AttachServerVolumeResponse.md
docs/Model/ScalewayInstanceV1BootType.md
docs/Model/ScalewayInstanceV1Bootscript.md
docs/Model/ScalewayInstanceV1CreateImageResponse.md
docs/Model/ScalewayInstanceV1CreateIpResponse.md
docs/Model/ScalewayInstanceV1CreatePlacementGroupResponse.md
docs/Model/ScalewayInstanceV1CreatePrivateNICResponse.md
docs/Model/ScalewayInstanceV1CreateSecurityGroupResponse.md
docs/Model/ScalewayInstanceV1CreateSecurityGroupRuleResponse.md
docs/Model/ScalewayInstanceV1CreateServerResponse.md
docs/Model/ScalewayInstanceV1CreateSnapshotResponse.md
docs/Model/ScalewayInstanceV1CreateVolumeResponse.md
docs/Model/ScalewayInstanceV1Dashboard.md
docs/Model/ScalewayInstanceV1DashboardServersByTypes.md
docs/Model/ScalewayInstanceV1DetachServerVolumeResponse.md
docs/Model/ScalewayInstanceV1ExportSnapshotResponse.md
docs/Model/ScalewayInstanceV1GetDashboardResponse.md
docs/Model/ScalewayInstanceV1GetImageResponse.md
docs/Model/ScalewayInstanceV1GetIpResponse.md
docs/Model/ScalewayInstanceV1GetPlacementGroupResponse.md
docs/Model/ScalewayInstanceV1GetPlacementGroupServersResponse.md
docs/Model/ScalewayInstanceV1GetPrivateNICResponse.md
docs/Model/ScalewayInstanceV1GetSecurityGroupResponse.md
docs/Model/ScalewayInstanceV1GetSecurityGroupRuleResponse.md
docs/Model/ScalewayInstanceV1GetServerResponse.md
docs/Model/ScalewayInstanceV1GetServerTypesAvailabilityResponse.md
docs/Model/ScalewayInstanceV1GetServerTypesAvailabilityResponseAvailability.md
docs/Model/ScalewayInstanceV1GetServerTypesAvailabilityResponseServers.md
docs/Model/ScalewayInstanceV1GetSnapshotResponse.md
docs/Model/ScalewayInstanceV1GetVolumeResponse.md
docs/Model/ScalewayInstanceV1Image.md
docs/Model/ScalewayInstanceV1ImageState.md
docs/Model/ScalewayInstanceV1Ip.md
docs/Model/ScalewayInstanceV1IpState.md
docs/Model/ScalewayInstanceV1IpType.md
docs/Model/ScalewayInstanceV1ListImagesResponse.md
docs/Model/ScalewayInstanceV1ListIpsResponse.md
docs/Model/ScalewayInstanceV1ListPlacementGroupsResponse.md
docs/Model/ScalewayInstanceV1ListPrivateNICsResponse.md
docs/Model/ScalewayInstanceV1ListSecurityGroupRulesResponse.md
docs/Model/ScalewayInstanceV1ListSecurityGroupsResponse.md
docs/Model/ScalewayInstanceV1ListServerActionsResponse.md
docs/Model/ScalewayInstanceV1ListServerUserDataResponse.md
docs/Model/ScalewayInstanceV1ListServersResponse.md
docs/Model/ScalewayInstanceV1ListServersTypesResponse.md
docs/Model/ScalewayInstanceV1ListServersTypesResponseServers.md
docs/Model/ScalewayInstanceV1ListSnapshotsResponse.md
docs/Model/ScalewayInstanceV1ListVolumesResponse.md
docs/Model/ScalewayInstanceV1ListVolumesTypesResponse.md
docs/Model/ScalewayInstanceV1ListVolumesTypesResponseVolumes.md
docs/Model/ScalewayInstanceV1MigrationPlan.md
docs/Model/ScalewayInstanceV1MigrationPlanVolume.md
docs/Model/ScalewayInstanceV1PlacementGroup.md
docs/Model/ScalewayInstanceV1PlacementGroupPolicyMode.md
docs/Model/ScalewayInstanceV1PlacementGroupPolicyType.md
docs/Model/ScalewayInstanceV1PlacementGroupServer.md
docs/Model/ScalewayInstanceV1PrivateNIC.md
docs/Model/ScalewayInstanceV1SecurityGroup.md
docs/Model/ScalewayInstanceV1SecurityGroupRule.md
docs/Model/ScalewayInstanceV1SecurityGroupRuleAction.md
docs/Model/ScalewayInstanceV1SecurityGroupRuleDirection.md
docs/Model/ScalewayInstanceV1SecurityGroupRuleProtocol.md
docs/Model/ScalewayInstanceV1SecurityGroupTemplate.md
docs/Model/ScalewayInstanceV1Server.md
docs/Model/ScalewayInstanceV1ServerAction.md
docs/Model/ScalewayInstanceV1ServerActionRequestVolumeBackupTemplate.md
docs/Model/ScalewayInstanceV1ServerActionResponse.md
docs/Model/ScalewayInstanceV1ServerImage.md
docs/Model/ScalewayInstanceV1ServerIp.md
docs/Model/ScalewayInstanceV1ServerIpv6.md
docs/Model/ScalewayInstanceV1ServerLocation.md
docs/Model/ScalewayInstanceV1ServerMaintenance.md
docs/Model/ScalewayInstanceV1ServerPlacementGroup.md
docs/Model/ScalewayInstanceV1ServerPublicIp.md
docs/Model/ScalewayInstanceV1ServerSecurityGroup.md
docs/Model/ScalewayInstanceV1ServerSummary.md
docs/Model/ScalewayInstanceV1ServerType.md
docs/Model/ScalewayInstanceV1ServerTypeCapabilities.md
docs/Model/ScalewayInstanceV1ServerTypeNetwork.md
docs/Model/ScalewayInstanceV1ServerTypeNetworkInterface.md
docs/Model/ScalewayInstanceV1ServerTypePerVolumeConstraint.md
docs/Model/ScalewayInstanceV1ServerTypePerVolumeConstraintLSsd.md
docs/Model/ScalewayInstanceV1ServerTypeVolumesConstraint.md
docs/Model/ScalewayInstanceV1ServerTypesAvailability.md
docs/Model/ScalewayInstanceV1ServerVolumes.md
docs/Model/ScalewayInstanceV1SetImageResponse.md
docs/Model/ScalewayInstanceV1SetPlacementGroupResponse.md
docs/Model/ScalewayInstanceV1SetPlacementGroupServersResponse.md
docs/Model/ScalewayInstanceV1SetSecurityGroupResponse.md
docs/Model/ScalewayInstanceV1SetSecurityGroupRuleResponse.md
docs/Model/ScalewayInstanceV1SetSecurityGroupRulesRequestRule.md
docs/Model/ScalewayInstanceV1SetSecurityGroupRulesResponse.md
docs/Model/ScalewayInstanceV1SetSnapshotResponse.md
docs/Model/ScalewayInstanceV1SetVolumeResponse.md
docs/Model/ScalewayInstanceV1Snapshot.md
docs/Model/ScalewayInstanceV1SnapshotBaseVolume.md
docs/Model/ScalewayInstanceV1SnapshotState.md
docs/Model/ScalewayInstanceV1Task.md
docs/Model/ScalewayInstanceV1UpdateImageResponse.md
docs/Model/ScalewayInstanceV1UpdateIpResponse.md
docs/Model/ScalewayInstanceV1UpdatePlacementGroupResponse.md
docs/Model/ScalewayInstanceV1UpdatePlacementGroupServersResponse.md
docs/Model/ScalewayInstanceV1UpdateSecurityGroupResponse.md
docs/Model/ScalewayInstanceV1UpdateSecurityGroupRuleResponse.md
docs/Model/ScalewayInstanceV1UpdateServerResponse.md
docs/Model/ScalewayInstanceV1UpdateSnapshotResponse.md
docs/Model/ScalewayInstanceV1UpdateVolumeResponse.md
docs/Model/ScalewayInstanceV1Volume.md
docs/Model/ScalewayInstanceV1VolumeImageUpdateTemplate.md
docs/Model/ScalewayInstanceV1VolumeServer.md
docs/Model/ScalewayInstanceV1VolumeServerState.md
docs/Model/ScalewayInstanceV1VolumeServerTemplate.md
docs/Model/ScalewayInstanceV1VolumeServerVolumeType.md
docs/Model/ScalewayInstanceV1VolumeSummary.md
docs/Model/ScalewayInstanceV1VolumeTemplate.md
docs/Model/ScalewayInstanceV1VolumeType.md
docs/Model/ScalewayInstanceV1VolumeTypeCapabilities.md
docs/Model/ScalewayInstanceV1VolumeTypeConstraints.md
docs/Model/ScalewayInstanceV1VolumeVolumeType.md
docs/Model/ScalewayStdFile.md
docs/Model/ServerActionRequest.md
docs/Model/ServerActionRequestVolumes.md
docs/Model/SetImageRequest.md
docs/Model/SetImageRequestExtraVolumes.md
docs/Model/SetPlacementGroupRequest.md
docs/Model/SetPlacementGroupServersRequest.md
docs/Model/SetSecurityGroupRequest.md
docs/Model/SetSecurityGroupRuleRequest.md
docs/Model/SetSecurityGroupRulesRequest.md
docs/Model/SetSnapshotRequest.md
docs/Model/SetVolumeRequest.md
docs/Model/SetVolumeRequestServer.md
docs/Model/UpdateImageRequest.md
docs/Model/UpdateImageRequestExtraVolumes.md
docs/Model/UpdateIpRequest.md
docs/Model/UpdatePlacementGroupRequest.md
docs/Model/UpdatePrivateNICRequest.md
docs/Model/UpdateSecurityGroupRequest.md
docs/Model/UpdateSecurityGroupRuleRequest.md
docs/Model/UpdateServerRequest.md
docs/Model/UpdateServerRequestVolumes.md
docs/Model/UpdateSnapshotRequest.md
docs/Model/UpdateVolumeRequest.md
git_push.sh
lib/Api/DefaultApi.php
lib/Api/IPsApi.php
lib/Api/ImagesApi.php
lib/Api/InstanceTypesApi.php
lib/Api/InstancesApi.php
lib/Api/PlacementGroupsApi.php
lib/Api/PrivateNICsApi.php
lib/Api/SecurityGroupsApi.php
lib/Api/SnapshotsApi.php
lib/Api/UserDataApi.php
lib/Api/VolumeTypesApi.php
lib/Api/VolumesApi.php
lib/ApiException.php
lib/Configuration.php
lib/HeaderSelector.php
lib/Model/ApplyBlockMigrationRequest.php
lib/Model/AttachServerVolumeRequest.php
lib/Model/CheckBlockMigrationOrganizationQuotasRequest.php
lib/Model/CreateImageRequest.php
lib/Model/CreateImageRequestExtraVolumes.php
lib/Model/CreateIpRequest.php
lib/Model/CreatePlacementGroupRequest.php
lib/Model/CreatePrivateNICRequest.php
lib/Model/CreateSecurityGroupRequest.php
lib/Model/CreateSecurityGroupRuleRequest.php
lib/Model/CreateServerRequest.php
lib/Model/CreateServerRequestVolumes.php
lib/Model/CreateSnapshotRequest.php
lib/Model/CreateVolumeRequest.php
lib/Model/DetachServerVolumeRequest.php
lib/Model/ExportSnapshotRequest.php
lib/Model/ModelInterface.php
lib/Model/PlanBlockMigrationRequest.php
lib/Model/ScalewayInstanceV1Arch.php
lib/Model/ScalewayInstanceV1AttachServerVolumeRequestVolumeType.php
lib/Model/ScalewayInstanceV1AttachServerVolumeResponse.php
lib/Model/ScalewayInstanceV1BootType.php
lib/Model/ScalewayInstanceV1Bootscript.php
lib/Model/ScalewayInstanceV1CreateImageResponse.php
lib/Model/ScalewayInstanceV1CreateIpResponse.php
lib/Model/ScalewayInstanceV1CreatePlacementGroupResponse.php
lib/Model/ScalewayInstanceV1CreatePrivateNICResponse.php
lib/Model/ScalewayInstanceV1CreateSecurityGroupResponse.php
lib/Model/ScalewayInstanceV1CreateSecurityGroupRuleResponse.php
lib/Model/ScalewayInstanceV1CreateServerResponse.php
lib/Model/ScalewayInstanceV1CreateSnapshotResponse.php
lib/Model/ScalewayInstanceV1CreateVolumeResponse.php
lib/Model/ScalewayInstanceV1Dashboard.php
lib/Model/ScalewayInstanceV1DashboardServersByTypes.php
lib/Model/ScalewayInstanceV1DetachServerVolumeResponse.php
lib/Model/ScalewayInstanceV1ExportSnapshotResponse.php
lib/Model/ScalewayInstanceV1GetDashboardResponse.php
lib/Model/ScalewayInstanceV1GetImageResponse.php
lib/Model/ScalewayInstanceV1GetIpResponse.php
lib/Model/ScalewayInstanceV1GetPlacementGroupResponse.php
lib/Model/ScalewayInstanceV1GetPlacementGroupServersResponse.php
lib/Model/ScalewayInstanceV1GetPrivateNICResponse.php
lib/Model/ScalewayInstanceV1GetSecurityGroupResponse.php
lib/Model/ScalewayInstanceV1GetSecurityGroupRuleResponse.php
lib/Model/ScalewayInstanceV1GetServerResponse.php
lib/Model/ScalewayInstanceV1GetServerTypesAvailabilityResponse.php
lib/Model/ScalewayInstanceV1GetServerTypesAvailabilityResponseAvailability.php
lib/Model/ScalewayInstanceV1GetServerTypesAvailabilityResponseServers.php
lib/Model/ScalewayInstanceV1GetSnapshotResponse.php
lib/Model/ScalewayInstanceV1GetVolumeResponse.php
lib/Model/ScalewayInstanceV1Image.php
lib/Model/ScalewayInstanceV1ImageState.php
lib/Model/ScalewayInstanceV1Ip.php
lib/Model/ScalewayInstanceV1IpState.php
lib/Model/ScalewayInstanceV1IpType.php
lib/Model/ScalewayInstanceV1ListImagesResponse.php
lib/Model/ScalewayInstanceV1ListIpsResponse.php
lib/Model/ScalewayInstanceV1ListPlacementGroupsResponse.php
lib/Model/ScalewayInstanceV1ListPrivateNICsResponse.php
lib/Model/ScalewayInstanceV1ListSecurityGroupRulesResponse.php
lib/Model/ScalewayInstanceV1ListSecurityGroupsResponse.php
lib/Model/ScalewayInstanceV1ListServerActionsResponse.php
lib/Model/ScalewayInstanceV1ListServerUserDataResponse.php
lib/Model/ScalewayInstanceV1ListServersResponse.php
lib/Model/ScalewayInstanceV1ListServersTypesResponse.php
lib/Model/ScalewayInstanceV1ListServersTypesResponseServers.php
lib/Model/ScalewayInstanceV1ListSnapshotsResponse.php
lib/Model/ScalewayInstanceV1ListVolumesResponse.php
lib/Model/ScalewayInstanceV1ListVolumesTypesResponse.php
lib/Model/ScalewayInstanceV1ListVolumesTypesResponseVolumes.php
lib/Model/ScalewayInstanceV1MigrationPlan.php
lib/Model/ScalewayInstanceV1MigrationPlanVolume.php
lib/Model/ScalewayInstanceV1PlacementGroup.php
lib/Model/ScalewayInstanceV1PlacementGroupPolicyMode.php
lib/Model/ScalewayInstanceV1PlacementGroupPolicyType.php
lib/Model/ScalewayInstanceV1PlacementGroupServer.php
lib/Model/ScalewayInstanceV1PrivateNIC.php
lib/Model/ScalewayInstanceV1SecurityGroup.php
lib/Model/ScalewayInstanceV1SecurityGroupRule.php
lib/Model/ScalewayInstanceV1SecurityGroupRuleAction.php
lib/Model/ScalewayInstanceV1SecurityGroupRuleDirection.php
lib/Model/ScalewayInstanceV1SecurityGroupRuleProtocol.php
lib/Model/ScalewayInstanceV1SecurityGroupTemplate.php
lib/Model/ScalewayInstanceV1Server.php
lib/Model/ScalewayInstanceV1ServerAction.php
lib/Model/ScalewayInstanceV1ServerActionRequestVolumeBackupTemplate.php
lib/Model/ScalewayInstanceV1ServerActionResponse.php
lib/Model/ScalewayInstanceV1ServerImage.php
lib/Model/ScalewayInstanceV1ServerIp.php
lib/Model/ScalewayInstanceV1ServerIpv6.php
lib/Model/ScalewayInstanceV1ServerLocation.php
lib/Model/ScalewayInstanceV1ServerMaintenance.php
lib/Model/ScalewayInstanceV1ServerPlacementGroup.php
lib/Model/ScalewayInstanceV1ServerPublicIp.php
lib/Model/ScalewayInstanceV1ServerSecurityGroup.php
lib/Model/ScalewayInstanceV1ServerSummary.php
lib/Model/ScalewayInstanceV1ServerType.php
lib/Model/ScalewayInstanceV1ServerTypeCapabilities.php
lib/Model/ScalewayInstanceV1ServerTypeNetwork.php
lib/Model/ScalewayInstanceV1ServerTypeNetworkInterface.php
lib/Model/ScalewayInstanceV1ServerTypePerVolumeConstraint.php
lib/Model/ScalewayInstanceV1ServerTypePerVolumeConstraintLSsd.php
lib/Model/ScalewayInstanceV1ServerTypeVolumesConstraint.php
lib/Model/ScalewayInstanceV1ServerTypesAvailability.php
lib/Model/ScalewayInstanceV1ServerVolumes.php
lib/Model/ScalewayInstanceV1SetImageResponse.php
lib/Model/ScalewayInstanceV1SetPlacementGroupResponse.php
lib/Model/ScalewayInstanceV1SetPlacementGroupServersResponse.php
lib/Model/ScalewayInstanceV1SetSecurityGroupResponse.php
lib/Model/ScalewayInstanceV1SetSecurityGroupRuleResponse.php
lib/Model/ScalewayInstanceV1SetSecurityGroupRulesRequestRule.php
lib/Model/ScalewayInstanceV1SetSecurityGroupRulesResponse.php
lib/Model/ScalewayInstanceV1SetSnapshotResponse.php
lib/Model/ScalewayInstanceV1SetVolumeResponse.php
lib/Model/ScalewayInstanceV1Snapshot.php
lib/Model/ScalewayInstanceV1SnapshotBaseVolume.php
lib/Model/ScalewayInstanceV1SnapshotState.php
lib/Model/ScalewayInstanceV1Task.php
lib/Model/ScalewayInstanceV1UpdateImageResponse.php
lib/Model/ScalewayInstanceV1UpdateIpResponse.php
lib/Model/ScalewayInstanceV1UpdatePlacementGroupResponse.php
lib/Model/ScalewayInstanceV1UpdatePlacementGroupServersResponse.php
lib/Model/ScalewayInstanceV1UpdateSecurityGroupResponse.php
lib/Model/ScalewayInstanceV1UpdateSecurityGroupRuleResponse.php
lib/Model/ScalewayInstanceV1UpdateServerResponse.php
lib/Model/ScalewayInstanceV1UpdateSnapshotResponse.php
lib/Model/ScalewayInstanceV1UpdateVolumeResponse.php
lib/Model/ScalewayInstanceV1Volume.php
lib/Model/ScalewayInstanceV1VolumeImageUpdateTemplate.php
lib/Model/ScalewayInstanceV1VolumeServer.php
lib/Model/ScalewayInstanceV1VolumeServerState.php
lib/Model/ScalewayInstanceV1VolumeServerTemplate.php
lib/Model/ScalewayInstanceV1VolumeServerVolumeType.php
lib/Model/ScalewayInstanceV1VolumeSummary.php
lib/Model/ScalewayInstanceV1VolumeTemplate.php
lib/Model/ScalewayInstanceV1VolumeType.php
lib/Model/ScalewayInstanceV1VolumeTypeCapabilities.php
lib/Model/ScalewayInstanceV1VolumeTypeConstraints.php
lib/Model/ScalewayInstanceV1VolumeVolumeType.php
lib/Model/ScalewayStdFile.php
lib/Model/ServerActionRequest.php
lib/Model/ServerActionRequestVolumes.php
lib/Model/SetImageRequest.php
lib/Model/SetImageRequestExtraVolumes.php
lib/Model/SetPlacementGroupRequest.php
lib/Model/SetPlacementGroupServersRequest.php
lib/Model/SetSecurityGroupRequest.php
lib/Model/SetSecurityGroupRuleRequest.php
lib/Model/SetSecurityGroupRulesRequest.php
lib/Model/SetSnapshotRequest.php
lib/Model/SetVolumeRequest.php
lib/Model/SetVolumeRequestServer.php
lib/Model/UpdateImageRequest.php
lib/Model/UpdateImageRequestExtraVolumes.php
lib/Model/UpdateIpRequest.php
lib/Model/UpdatePlacementGroupRequest.php
lib/Model/UpdatePrivateNICRequest.php
lib/Model/UpdateSecurityGroupRequest.php
lib/Model/UpdateSecurityGroupRuleRequest.php
lib/Model/UpdateServerRequest.php
lib/Model/UpdateServerRequestVolumes.php
lib/Model/UpdateSnapshotRequest.php
lib/Model/UpdateVolumeRequest.php
lib/ObjectSerializer.php
phpunit.xml.dist
test/Api/DefaultApiTest.php
test/Api/IPsApiTest.php
test/Api/ImagesApiTest.php
test/Api/InstanceTypesApiTest.php
test/Api/InstancesApiTest.php
test/Api/PlacementGroupsApiTest.php
test/Api/PrivateNICsApiTest.php
test/Api/SecurityGroupsApiTest.php
test/Api/SnapshotsApiTest.php
test/Api/UserDataApiTest.php
test/Api/VolumeTypesApiTest.php
test/Api/VolumesApiTest.php
test/Model/ApplyBlockMigrationRequestTest.php
test/Model/AttachServerVolumeRequestTest.php
test/Model/CheckBlockMigrationOrganizationQuotasRequestTest.php
test/Model/CreateImageRequestExtraVolumesTest.php
test/Model/CreateImageRequestTest.php
test/Model/CreateIpRequestTest.php
test/Model/CreatePlacementGroupRequestTest.php
test/Model/CreatePrivateNICRequestTest.php
test/Model/CreateSecurityGroupRequestTest.php
test/Model/CreateSecurityGroupRuleRequestTest.php
test/Model/CreateServerRequestTest.php
test/Model/CreateServerRequestVolumesTest.php
test/Model/CreateSnapshotRequestTest.php
test/Model/CreateVolumeRequestTest.php
test/Model/DetachServerVolumeRequestTest.php
test/Model/ExportSnapshotRequestTest.php
test/Model/PlanBlockMigrationRequestTest.php
test/Model/ScalewayInstanceV1ArchTest.php
test/Model/ScalewayInstanceV1AttachServerVolumeRequestVolumeTypeTest.php
test/Model/ScalewayInstanceV1AttachServerVolumeResponseTest.php
test/Model/ScalewayInstanceV1BootTypeTest.php
test/Model/ScalewayInstanceV1BootscriptTest.php
test/Model/ScalewayInstanceV1CreateImageResponseTest.php
test/Model/ScalewayInstanceV1CreateIpResponseTest.php
test/Model/ScalewayInstanceV1CreatePlacementGroupResponseTest.php
test/Model/ScalewayInstanceV1CreatePrivateNICResponseTest.php
test/Model/ScalewayInstanceV1CreateSecurityGroupResponseTest.php
test/Model/ScalewayInstanceV1CreateSecurityGroupRuleResponseTest.php
test/Model/ScalewayInstanceV1CreateServerResponseTest.php
test/Model/ScalewayInstanceV1CreateSnapshotResponseTest.php
test/Model/ScalewayInstanceV1CreateVolumeResponseTest.php
test/Model/ScalewayInstanceV1DashboardServersByTypesTest.php
test/Model/ScalewayInstanceV1DashboardTest.php
test/Model/ScalewayInstanceV1DetachServerVolumeResponseTest.php
test/Model/ScalewayInstanceV1ExportSnapshotResponseTest.php
test/Model/ScalewayInstanceV1GetDashboardResponseTest.php
test/Model/ScalewayInstanceV1GetImageResponseTest.php
test/Model/ScalewayInstanceV1GetIpResponseTest.php
test/Model/ScalewayInstanceV1GetPlacementGroupResponseTest.php
test/Model/ScalewayInstanceV1GetPlacementGroupServersResponseTest.php
test/Model/ScalewayInstanceV1GetPrivateNICResponseTest.php
test/Model/ScalewayInstanceV1GetSecurityGroupResponseTest.php
test/Model/ScalewayInstanceV1GetSecurityGroupRuleResponseTest.php
test/Model/ScalewayInstanceV1GetServerResponseTest.php
test/Model/ScalewayInstanceV1GetServerTypesAvailabilityResponseAvailabilityTest.php
test/Model/ScalewayInstanceV1GetServerTypesAvailabilityResponseServersTest.php
test/Model/ScalewayInstanceV1GetServerTypesAvailabilityResponseTest.php
test/Model/ScalewayInstanceV1GetSnapshotResponseTest.php
test/Model/ScalewayInstanceV1GetVolumeResponseTest.php
test/Model/ScalewayInstanceV1ImageStateTest.php
test/Model/ScalewayInstanceV1ImageTest.php
test/Model/ScalewayInstanceV1IpStateTest.php
test/Model/ScalewayInstanceV1IpTest.php
test/Model/ScalewayInstanceV1IpTypeTest.php
test/Model/ScalewayInstanceV1ListImagesResponseTest.php
test/Model/ScalewayInstanceV1ListIpsResponseTest.php
test/Model/ScalewayInstanceV1ListPlacementGroupsResponseTest.php
test/Model/ScalewayInstanceV1ListPrivateNICsResponseTest.php
test/Model/ScalewayInstanceV1ListSecurityGroupRulesResponseTest.php
test/Model/ScalewayInstanceV1ListSecurityGroupsResponseTest.php
test/Model/ScalewayInstanceV1ListServerActionsResponseTest.php
test/Model/ScalewayInstanceV1ListServerUserDataResponseTest.php
test/Model/ScalewayInstanceV1ListServersResponseTest.php
test/Model/ScalewayInstanceV1ListServersTypesResponseServersTest.php
test/Model/ScalewayInstanceV1ListServersTypesResponseTest.php
test/Model/ScalewayInstanceV1ListSnapshotsResponseTest.php
test/Model/ScalewayInstanceV1ListVolumesResponseTest.php
test/Model/ScalewayInstanceV1ListVolumesTypesResponseTest.php
test/Model/ScalewayInstanceV1ListVolumesTypesResponseVolumesTest.php
test/Model/ScalewayInstanceV1MigrationPlanTest.php
test/Model/ScalewayInstanceV1MigrationPlanVolumeTest.php
test/Model/ScalewayInstanceV1PlacementGroupPolicyModeTest.php
test/Model/ScalewayInstanceV1PlacementGroupPolicyTypeTest.php
test/Model/ScalewayInstanceV1PlacementGroupServerTest.php
test/Model/ScalewayInstanceV1PlacementGroupTest.php
test/Model/ScalewayInstanceV1PrivateNICTest.php
test/Model/ScalewayInstanceV1SecurityGroupRuleActionTest.php
test/Model/ScalewayInstanceV1SecurityGroupRuleDirectionTest.php
test/Model/ScalewayInstanceV1SecurityGroupRuleProtocolTest.php
test/Model/ScalewayInstanceV1SecurityGroupRuleTest.php
test/Model/ScalewayInstanceV1SecurityGroupTemplateTest.php
test/Model/ScalewayInstanceV1SecurityGroupTest.php
test/Model/ScalewayInstanceV1ServerActionRequestVolumeBackupTemplateTest.php
test/Model/ScalewayInstanceV1ServerActionResponseTest.php
test/Model/ScalewayInstanceV1ServerActionTest.php
test/Model/ScalewayInstanceV1ServerImageTest.php
test/Model/ScalewayInstanceV1ServerIpTest.php
test/Model/ScalewayInstanceV1ServerIpv6Test.php
test/Model/ScalewayInstanceV1ServerLocationTest.php
test/Model/ScalewayInstanceV1ServerMaintenanceTest.php
test/Model/ScalewayInstanceV1ServerPlacementGroupTest.php
test/Model/ScalewayInstanceV1ServerPublicIpTest.php
test/Model/ScalewayInstanceV1ServerSecurityGroupTest.php
test/Model/ScalewayInstanceV1ServerSummaryTest.php
test/Model/ScalewayInstanceV1ServerTest.php
test/Model/ScalewayInstanceV1ServerTypeCapabilitiesTest.php
test/Model/ScalewayInstanceV1ServerTypeNetworkInterfaceTest.php
test/Model/ScalewayInstanceV1ServerTypeNetworkTest.php
test/Model/ScalewayInstanceV1ServerTypePerVolumeConstraintLSsdTest.php
test/Model/ScalewayInstanceV1ServerTypePerVolumeConstraintTest.php
test/Model/ScalewayInstanceV1ServerTypeTest.php
test/Model/ScalewayInstanceV1ServerTypeVolumesConstraintTest.php
test/Model/ScalewayInstanceV1ServerTypesAvailabilityTest.php
test/Model/ScalewayInstanceV1ServerVolumesTest.php
test/Model/ScalewayInstanceV1SetImageResponseTest.php
test/Model/ScalewayInstanceV1SetPlacementGroupResponseTest.php
test/Model/ScalewayInstanceV1SetPlacementGroupServersResponseTest.php
test/Model/ScalewayInstanceV1SetSecurityGroupResponseTest.php
test/Model/ScalewayInstanceV1SetSecurityGroupRuleResponseTest.php
test/Model/ScalewayInstanceV1SetSecurityGroupRulesRequestRuleTest.php
test/Model/ScalewayInstanceV1SetSecurityGroupRulesResponseTest.php
test/Model/ScalewayInstanceV1SetSnapshotResponseTest.php
test/Model/ScalewayInstanceV1SetVolumeResponseTest.php
test/Model/ScalewayInstanceV1SnapshotBaseVolumeTest.php
test/Model/ScalewayInstanceV1SnapshotStateTest.php
test/Model/ScalewayInstanceV1SnapshotTest.php
test/Model/ScalewayInstanceV1TaskTest.php
test/Model/ScalewayInstanceV1UpdateImageResponseTest.php
test/Model/ScalewayInstanceV1UpdateIpResponseTest.php
test/Model/ScalewayInstanceV1UpdatePlacementGroupResponseTest.php
test/Model/ScalewayInstanceV1UpdatePlacementGroupServersResponseTest.php
test/Model/ScalewayInstanceV1UpdateSecurityGroupResponseTest.php
test/Model/ScalewayInstanceV1UpdateSecurityGroupRuleResponseTest.php
test/Model/ScalewayInstanceV1UpdateServerResponseTest.php
test/Model/ScalewayInstanceV1UpdateSnapshotResponseTest.php
test/Model/ScalewayInstanceV1UpdateVolumeResponseTest.php
test/Model/ScalewayInstanceV1VolumeImageUpdateTemplateTest.php
test/Model/ScalewayInstanceV1VolumeServerStateTest.php
test/Model/ScalewayInstanceV1VolumeServerTemplateTest.php
test/Model/ScalewayInstanceV1VolumeServerTest.php
test/Model/ScalewayInstanceV1VolumeServerVolumeTypeTest.php
test/Model/ScalewayInstanceV1VolumeSummaryTest.php
test/Model/ScalewayInstanceV1VolumeTemplateTest.php
test/Model/ScalewayInstanceV1VolumeTest.php
test/Model/ScalewayInstanceV1VolumeTypeCapabilitiesTest.php
test/Model/ScalewayInstanceV1VolumeTypeConstraintsTest.php
test/Model/ScalewayInstanceV1VolumeTypeTest.php
test/Model/ScalewayInstanceV1VolumeVolumeTypeTest.php
test/Model/ScalewayStdFileTest.php
test/Model/ServerActionRequestTest.php
test/Model/ServerActionRequestVolumesTest.php
test/Model/SetImageRequestExtraVolumesTest.php
test/Model/SetImageRequestTest.php
test/Model/SetPlacementGroupRequestTest.php
test/Model/SetPlacementGroupServersRequestTest.php
test/Model/SetSecurityGroupRequestTest.php
test/Model/SetSecurityGroupRuleRequestTest.php
test/Model/SetSecurityGroupRulesRequestTest.php
test/Model/SetSnapshotRequestTest.php
test/Model/SetVolumeRequestServerTest.php
test/Model/SetVolumeRequestTest.php
test/Model/UpdateImageRequestExtraVolumesTest.php
test/Model/UpdateImageRequestTest.php
test/Model/UpdateIpRequestTest.php
test/Model/UpdatePlacementGroupRequestTest.php
test/Model/UpdatePrivateNICRequestTest.php
test/Model/UpdateSecurityGroupRequestTest.php
test/Model/UpdateSecurityGroupRuleRequestTest.php
test/Model/UpdateServerRequestTest.php
test/Model/UpdateServerRequestVolumesTest.php
test/Model/UpdateSnapshotRequestTest.php
test/Model/UpdateVolumeRequestTest.php

View file

@ -0,0 +1 @@
7.11.0

29
.php-cs-fixer.dist.php Normal file
View file

@ -0,0 +1,29 @@
<?php
/**
* @generated
* @link https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/HEAD/doc/config.rst
*/
$finder = PhpCsFixer\Finder::create()
->in(__DIR__)
->exclude('vendor')
->exclude('test')
->exclude('tests')
;
$config = new PhpCsFixer\Config();
return $config->setRules([
'@PSR12' => true,
'phpdoc_order' => true,
'array_syntax' => [ 'syntax' => 'short' ],
'strict_comparison' => true,
'strict_param' => true,
'no_trailing_whitespace' => false,
'no_trailing_whitespace_in_comment' => false,
'braces' => false,
'single_blank_line_at_eof' => false,
'blank_line_after_namespace' => false,
'no_leading_import_slash' => false,
])
->setFinder($finder)
;

8
.travis.yml Normal file
View file

@ -0,0 +1,8 @@
language: php
# Bionic environment has preinstalled PHP from 7.1 to 7.4
# https://docs.travis-ci.com/user/reference/bionic/#php-support
dist: bionic
php:
- 7.4
before_install: "composer install"
script: "vendor/bin/phpunit"

510
README.md Normal file
View file

@ -0,0 +1,510 @@
# OpenAPIClient-php
Scaleway Instances are virtual machines in the cloud. Different [Instance types](https://www.scaleway.com/en/docs/compute/instances/reference-content/choosing-instance-type/) offer different technical specifications in terms of vCPU, RAM, bandwidth and storage. Once you have created your Instance and installed your image of choice (e.g. an operating system), you can [connect to your Instance via SSH](https://www.scaleway.com/en/docs/compute/instances/how-to/connect-to-instance/) to use it as you wish. When you are done using the Instance, you can delete it from your account.
(switchcolumn)
<Message type=\"tip\">
To retrieve information about the different [images](#path-images) available to install on Scaleway Instances, check out our [Marketplace API](https://www.scaleway.com/en/developers/api/marketplace).
</Message>
(switchcolumn)
## Concepts
Refer to our [dedicated concepts page](https://www.scaleway.com/en/docs/compute/instances/concepts/) to find definitions of all concepts and terminology related to Instances.
(switchcolumn)
(switchcolumn)
## Quickstart
1. Configure your environment variables
<Message type=\"note\">
This is an optional step that seeks to simplify your usage of the Instances API. See [Availability Zones](#availability-zones) below for help choosing an Availability Zone. You can find your Project ID in the [Scaleway console](https://console.scaleway.com/project/settings).
</Message>
```bash
export SCW_SECRET_KEY=\"<API secret key>\"
export SCW_DEFAULT_ZONE=\"<Scaleway Availability Zone>\"
export SCW_PROJECT_ID=\"<Scaleway Project ID>\"
```
2. **Create an Instance**: Run the following command to create an Instance. You can customize the details in the payload (name, description, type, tags etc) to your needs: use the information below to adjust the payload as necessary.
```bash
curl -X POST \\
-H \"X-Auth-Token: $SCW_SECRET_KEY\" \\
-H \"Content-Type: application/json\" \\
\"https://api.scaleway.com/instance/v1/zones/$SCW_DEFAULT_ZONE/servers\" \\
-d '{
\"name\": \"my-new-instance\",
\"project\": \"'\"$SCW_PROJECT_ID\"'\",
\"commercial_type\": \"GP1-S\",
\"image\": \"ubuntu_noble\",
\"enable_ipv6\": true,
\"volumes\": {
\"0\":{
\"size\": 300000000000,
\"volume_type\": \"l_ssd\"
}
}
}'
```
| Parameter | Description | Valid values |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | A name of your choice for the Instance (string) | Any string containing only alphanumeric characters, dots, spaces and dashes, e.g. `\"my-new-instance\"`. |
| `project` | The Project in which the Instance should be created (string) | Any valid Scaleway Project ID (see above), e.g. `\"b4bd99e0-b389-11ed-afa1-0242ac120002\"` |
| `commercial-type` | The commercial Instance type to create (string) | Any valid ID of a Scaleway commercial Instance type, e.g. `\"GP1-S\"`, `\"PRO2-M\"`. Use the [List Instance Types](#path-instance-types-list-instance-types) endpoint to get a list of all valid Instance types and their IDs. |
| `image` | The image to install on the Instance, e.g. a particular OS (string) | Any Scaleway image label, e.g. `\"ubuntu_noble\"`, or any valid Scaleway image ID, e.g. `\"6fc0ade6-d6a3-4fb9-87ab-2444ac71e5c0\"` which is the ID for the `Ubuntu 24.04 Noble Numbat` image. Use the [List Instance Images](#path-images-list-instance-images) endpoint to get a list of all available images with their IDs and labels, or check out the [Scaleway Marketplace API](https://www.scaleway.com/en/developers/api/marketplace). |
| `enable_ipv6` | Whether to enable IPv6 on the Instance (boolean) | `true` or `false` |
| `volumes` | An object that specifies the storage volumes to attach to the Instance. For more information, see **Creating an Instance: the volumes object** in the [Technical information](#technical-information) section of this quickstart. | A (dictionary) object with a minimum of one key (`\"0\"`) whose value is another object containing the parameters `\"name\"` (a name for the volume), `\"size\"` (the size for the volume, in bytes), and `\"volume_type\"` (`\"l_ssd\"` or `\"b_ssd\"`). Additional keys for additional volumes should increment by 1 each time (the second volume would have a key of `1`.) Further parameters are available, and it is possible to attach existing volumes rather than creating a new one, or create a volume from a snapshot. |
3. **List your Instances**: run the following command to get a list of all the Instances in your account, with their details:
```bash
curl -X GET \\
-H \"Content-Type: application/json\" \\
-H \"X-Auth-Token: $SCW_SECRET_KEY\" \\
\"https://api.scaleway.com/instance/v1/zones/$SCW_DEFAULT_ZONE/servers/\"
```
4. **Delete an Instance**: run the following command to delete an Instance, specified by its Instance ID:
```bash
curl -X DELETE \\
-H \"X-Auth-Token: $SCW_SECRET_KEY\" \\
-H \"Content-Type: application/json\" \\
\"https://api.scaleway.com/instance/v1/zones/$SCW_DEFAULT_ZONE/servers/<Instance-ID>\"
```
The expected successful response is empty.
(switchcolumn)
<Message type=\"requirement\">
- You have a [Scaleway account](https://console.scaleway.com/)
- You have created an [API key](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/) and that the API key has sufficient [IAM permissions](https://www.scaleway.com/en/docs/identity-and-access-management/iam/reference-content/permission-sets/) to perform the actions described on this page
- You have [installed `curl`](https://curl.se/download.html)
</Message>
(switchcolumn)
## Technical information
### Availability Zones
Instances can be deployed in the following Availability Zones:
| Name | API ID |
|-----------|-----------------------|
| Paris | `fr-par-1` `fr-par-2` `fr-par-3` |
| Amsterdam | `nl-ams-1` `nl-ams-2` |
| Warsaw | `pl-waw-1` `pl-waw-2` |
(switchcolumn)
(switchcolumn)
### Pagination
Most listing requests receive a paginated response. Requests against paginated endpoints accept two `query` arguments:
- `page`, a positive integer to choose which page to return.
- `per_page`, an positive integer lower or equal to 100 to select the number of items to return per page. The default value is `50`.
Paginated endpoints usually also accept filters to search and sort results.These filters are documented along each endpoint documentation.
The `X-Total-Count` header contains the total number of items returned.
(switchcolumn)
(switchcolumn)
### Creating an Instance: the volumes object
When [creating an Instance](#path-instances-create-an-instance) using the Scaleway API, the `volumes` object is **not strictly required**. However, the defaults vary depending on certain conditions:
1. If an image label is used:
- The default will be an `sbs_volume` volume.
- The size of this volume will be the OS size (typically 10GB in most cases).
2. If an image ID from the marketplace is used (or any image based on a unified snapshot):
- If the Instance supports local storage:
- The default will be an `l_ssd` volume.
- The size of this volume will be the instance's maximum local storage capacity.
- If the Instance does not support local storage:
- The default will be a `b_ssd` volume.
- The size of this volume will be the OS size.
If you want to customize the storage configuration or add additional volumes, you will need to include the volumes object in your API request. This object should contain at least one (dictionary) object with a minimum of one key (`\"0\"`) whose value is another object containing the parameters `\"name\"` (a name for the volume), `\"size\"` (the size for the volume, in bytes), and `\"volume_type\"` (`\"sbs_volume\"`, `\"l_ssd\"` or `\"b_ssd\"`). Additional keys for additional volumes should increment by 1 each time (the second volume would have a key of `\"1\"`.)
Note that volume `size` must respect the volume constraints of the Instance's `commercial_type`: for each type of Instance, a minimum amount of storage is required, and there is also a maximum that cannot be exceeded. All Instance types support Block Storage (`sbs_volume`, `b_ssd`), some also support local storage (`l_ssd`). Read more about these constraints in the [List Instance types](#path-instance-types-list-instance-types) documentation, specifically the `volume_constraints` parameter for each type listed in the response
You can use the `volumes` object in different ways. The table below shows which parameters are required for each of the following use cases:
| Use case | Required params | Optional params | Notes |
|-------------------------|-----------------------|---------------------|----------------------------------------|
| Create a volume (`l_ssd`, `b_ssd`, `sbs_volume`) from a snapshot of an image | | `volume_type`, `size`, `boot` | If the `size` parameter is not set, the size of the volume will equal the size of the corresponding snapshot of the image. The image snapshot type should be compatible with the `volume_type`. |
| Create a volume (`l_ssd`, `b_ssd`) from a snapshot | `base_snapshot`, `name`, `volume_type` | `boot` | |
| Create a volume of type `sbs_volume` from a snapshot | `base_snapshot`, `name`, `volume_type` | `size`, `boot` | |
| Create an empty volume | `name`, `volume_type`, `size` | `boot` | |
| Attach an existing volume (`l_ssd`, `b_ssd`) | `id` | `boot` | |
| Attach an existing volume of type `sbs_volume` | `id`, `volume_type` | `boot` | |
(switchcolumn)
<Message type=\"note\">
This information is designed to help you correctly configure the `volumes` object when using the [Create an Instance](#path-instances-create-an-instance) or [Update an Instance](#path-instances-update-an-instance) methods.
</Message>
(switchcolumn)
## Going further
For more help using Scaleway Instances, check out the following resources:
- Our [main documentation](https://www.scaleway.com/en/docs/compute/instances/)
- The #instance channel on our [Slack Community](https://www.scaleway.com/en/docs/tutorials/scaleway-slack-community/)
- Our [support ticketing system](https://www.scaleway.com/en/docs/console/my-account/how-to/open-a-support-ticket/).
## Installation & Usage
### Requirements
PHP 7.4 and later.
Should also work with PHP 8.0.
### Composer
To install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`:
```json
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
}
],
"require": {
"GIT_USER_ID/GIT_REPO_ID": "*@dev"
}
}
```
Then run `composer install`
### Manual Installation
Download the files and include `autoload.php`:
```php
<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\DefaultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$server_id = 'server_id_example'; // string
$attach_server_volume_request = new \OpenAPI\Client\Model\AttachServerVolumeRequest(); // \OpenAPI\Client\Model\AttachServerVolumeRequest
try {
$result = $apiInstance->attachServerVolume($zone, $server_id, $attach_server_volume_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->attachServerVolume: ', $e->getMessage(), PHP_EOL;
}
```
## API Endpoints
All URIs are relative to *https://api.scaleway.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**attachServerVolume**](docs/Api/DefaultApi.md#attachservervolume) | **POST** /instance/v1/zones/{zone}/servers/{server_id}/attach-volume |
*DefaultApi* | [**checkBlockMigrationOrganizationQuotas**](docs/Api/DefaultApi.md#checkblockmigrationorganizationquotas) | **POST** /instance/v1/zones/{zone}/block-migration/check-organization-quotas |
*DefaultApi* | [**detachServerVolume**](docs/Api/DefaultApi.md#detachservervolume) | **POST** /instance/v1/zones/{zone}/servers/{server_id}/detach-volume |
*DefaultApi* | [**getDashboard**](docs/Api/DefaultApi.md#getdashboard) | **GET** /instance/v1/zones/{zone}/dashboard |
*IPsApi* | [**createIp**](docs/Api/IPsApi.md#createip) | **POST** /instance/v1/zones/{zone}/ips | Reserve a flexible IP
*IPsApi* | [**deleteIp**](docs/Api/IPsApi.md#deleteip) | **DELETE** /instance/v1/zones/{zone}/ips/{ip} | Delete a flexible IP
*IPsApi* | [**getIp**](docs/Api/IPsApi.md#getip) | **GET** /instance/v1/zones/{zone}/ips/{ip} | Get a flexible IP
*IPsApi* | [**listIps**](docs/Api/IPsApi.md#listips) | **GET** /instance/v1/zones/{zone}/ips | List all flexible IPs
*IPsApi* | [**updateIp**](docs/Api/IPsApi.md#updateip) | **PATCH** /instance/v1/zones/{zone}/ips/{ip} | Update a flexible IP
*ImagesApi* | [**createImage**](docs/Api/ImagesApi.md#createimage) | **POST** /instance/v1/zones/{zone}/images | Create an Instance image
*ImagesApi* | [**deleteImage**](docs/Api/ImagesApi.md#deleteimage) | **DELETE** /instance/v1/zones/{zone}/images/{image_id} | Delete an Instance image
*ImagesApi* | [**getImage**](docs/Api/ImagesApi.md#getimage) | **GET** /instance/v1/zones/{zone}/images/{image_id} | Get an Instance image
*ImagesApi* | [**listImages**](docs/Api/ImagesApi.md#listimages) | **GET** /instance/v1/zones/{zone}/images | List Instance images
*ImagesApi* | [**setImage**](docs/Api/ImagesApi.md#setimage) | **PUT** /instance/v1/zones/{zone}/images/{id} | Update image
*ImagesApi* | [**updateImage**](docs/Api/ImagesApi.md#updateimage) | **PATCH** /instance/v1/zones/{zone}/images/{image_id} | Update image
*InstanceTypesApi* | [**getServerTypesAvailability**](docs/Api/InstanceTypesApi.md#getservertypesavailability) | **GET** /instance/v1/zones/{zone}/products/servers/availability | Get availability
*InstanceTypesApi* | [**listServersTypes**](docs/Api/InstanceTypesApi.md#listserverstypes) | **GET** /instance/v1/zones/{zone}/products/servers | List Instance types
*InstancesApi* | [**createServer**](docs/Api/InstancesApi.md#createserver) | **POST** /instance/v1/zones/{zone}/servers | Create an Instance
*InstancesApi* | [**deleteServer**](docs/Api/InstancesApi.md#deleteserver) | **DELETE** /instance/v1/zones/{zone}/servers/{server_id} | Delete an Instance
*InstancesApi* | [**getServer**](docs/Api/InstancesApi.md#getserver) | **GET** /instance/v1/zones/{zone}/servers/{server_id} | Get an Instance
*InstancesApi* | [**listServerActions**](docs/Api/InstancesApi.md#listserveractions) | **GET** /instance/v1/zones/{zone}/servers/{server_id}/action | List Instance actions
*InstancesApi* | [**listServers**](docs/Api/InstancesApi.md#listservers) | **GET** /instance/v1/zones/{zone}/servers | List all Instances
*InstancesApi* | [**serverAction**](docs/Api/InstancesApi.md#serveraction) | **POST** /instance/v1/zones/{zone}/servers/{server_id}/action | Perform action
*InstancesApi* | [**updateServer**](docs/Api/InstancesApi.md#updateserver) | **PATCH** /instance/v1/zones/{zone}/servers/{server_id} | Update an Instance
*PlacementGroupsApi* | [**createPlacementGroup**](docs/Api/PlacementGroupsApi.md#createplacementgroup) | **POST** /instance/v1/zones/{zone}/placement_groups | Create a placement group
*PlacementGroupsApi* | [**deletePlacementGroup**](docs/Api/PlacementGroupsApi.md#deleteplacementgroup) | **DELETE** /instance/v1/zones/{zone}/placement_groups/{placement_group_id} | Delete the specified placement group
*PlacementGroupsApi* | [**getPlacementGroup**](docs/Api/PlacementGroupsApi.md#getplacementgroup) | **GET** /instance/v1/zones/{zone}/placement_groups/{placement_group_id} | Get a placement group
*PlacementGroupsApi* | [**getPlacementGroupServers**](docs/Api/PlacementGroupsApi.md#getplacementgroupservers) | **GET** /instance/v1/zones/{zone}/placement_groups/{placement_group_id}/servers | Get placement group servers
*PlacementGroupsApi* | [**listPlacementGroups**](docs/Api/PlacementGroupsApi.md#listplacementgroups) | **GET** /instance/v1/zones/{zone}/placement_groups | List placement groups
*PlacementGroupsApi* | [**setPlacementGroup**](docs/Api/PlacementGroupsApi.md#setplacementgroup) | **PUT** /instance/v1/zones/{zone}/placement_groups/{placement_group_id} | Set placement group
*PlacementGroupsApi* | [**setPlacementGroupServers**](docs/Api/PlacementGroupsApi.md#setplacementgroupservers) | **PUT** /instance/v1/zones/{zone}/placement_groups/{placement_group_id}/servers | Set placement group servers
*PlacementGroupsApi* | [**updatePlacementGroup**](docs/Api/PlacementGroupsApi.md#updateplacementgroup) | **PATCH** /instance/v1/zones/{zone}/placement_groups/{placement_group_id} | Update a placement group
*PlacementGroupsApi* | [**updatePlacementGroupServers**](docs/Api/PlacementGroupsApi.md#updateplacementgroupservers) | **PATCH** /instance/v1/zones/{zone}/placement_groups/{placement_group_id}/servers | Update placement group servers
*PrivateNICsApi* | [**createPrivateNIC**](docs/Api/PrivateNICsApi.md#createprivatenic) | **POST** /instance/v1/zones/{zone}/servers/{server_id}/private_nics | Create a private NIC connecting an Instance to a Private Network
*PrivateNICsApi* | [**deletePrivateNIC**](docs/Api/PrivateNICsApi.md#deleteprivatenic) | **DELETE** /instance/v1/zones/{zone}/servers/{server_id}/private_nics/{private_nic_id} | Delete a private NIC
*PrivateNICsApi* | [**getPrivateNIC**](docs/Api/PrivateNICsApi.md#getprivatenic) | **GET** /instance/v1/zones/{zone}/servers/{server_id}/private_nics/{private_nic_id} | Get a private NIC
*PrivateNICsApi* | [**listPrivateNICs**](docs/Api/PrivateNICsApi.md#listprivatenics) | **GET** /instance/v1/zones/{zone}/servers/{server_id}/private_nics | List all private NICs
*PrivateNICsApi* | [**updatePrivateNIC**](docs/Api/PrivateNICsApi.md#updateprivatenic) | **PATCH** /instance/v1/zones/{zone}/servers/{server_id}/private_nics/{private_nic_id} | Update a private NIC
*SecurityGroupsApi* | [**createSecurityGroup**](docs/Api/SecurityGroupsApi.md#createsecuritygroup) | **POST** /instance/v1/zones/{zone}/security_groups | Create a security group
*SecurityGroupsApi* | [**createSecurityGroupRule**](docs/Api/SecurityGroupsApi.md#createsecuritygrouprule) | **POST** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules | Create rule
*SecurityGroupsApi* | [**deleteSecurityGroup**](docs/Api/SecurityGroupsApi.md#deletesecuritygroup) | **DELETE** /instance/v1/zones/{zone}/security_groups/{security_group_id} | Delete a security group
*SecurityGroupsApi* | [**deleteSecurityGroupRule**](docs/Api/SecurityGroupsApi.md#deletesecuritygrouprule) | **DELETE** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules/{security_group_rule_id} | Delete rule
*SecurityGroupsApi* | [**getSecurityGroup**](docs/Api/SecurityGroupsApi.md#getsecuritygroup) | **GET** /instance/v1/zones/{zone}/security_groups/{security_group_id} | Get a security group
*SecurityGroupsApi* | [**getSecurityGroupRule**](docs/Api/SecurityGroupsApi.md#getsecuritygrouprule) | **GET** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules/{security_group_rule_id} | Get rule
*SecurityGroupsApi* | [**listDefaultSecurityGroupRules**](docs/Api/SecurityGroupsApi.md#listdefaultsecuritygrouprules) | **GET** /instance/v1/zones/{zone}/security_groups/default/rules | Get default rules
*SecurityGroupsApi* | [**listSecurityGroupRules**](docs/Api/SecurityGroupsApi.md#listsecuritygrouprules) | **GET** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules | List rules
*SecurityGroupsApi* | [**listSecurityGroups**](docs/Api/SecurityGroupsApi.md#listsecuritygroups) | **GET** /instance/v1/zones/{zone}/security_groups | List security groups
*SecurityGroupsApi* | [**setSecurityGroup**](docs/Api/SecurityGroupsApi.md#setsecuritygroup) | **PUT** /instance/v1/zones/{zone}/security_groups/{id} | Update a security group
*SecurityGroupsApi* | [**setSecurityGroupRule**](docs/Api/SecurityGroupsApi.md#setsecuritygrouprule) | **PUT** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules/{security_group_rule_id} | Set security group rule
*SecurityGroupsApi* | [**setSecurityGroupRules**](docs/Api/SecurityGroupsApi.md#setsecuritygrouprules) | **PUT** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules | Update all the rules of a security group
*SecurityGroupsApi* | [**updateSecurityGroup**](docs/Api/SecurityGroupsApi.md#updatesecuritygroup) | **PATCH** /instance/v1/zones/{zone}/security_groups/{security_group_id} | Update a security group
*SecurityGroupsApi* | [**updateSecurityGroupRule**](docs/Api/SecurityGroupsApi.md#updatesecuritygrouprule) | **PATCH** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules/{security_group_rule_id} | Update security group rule
*SnapshotsApi* | [**createSnapshot**](docs/Api/SnapshotsApi.md#createsnapshot) | **POST** /instance/v1/zones/{zone}/snapshots | Create a snapshot from a specified volume or from a QCOW2 file
*SnapshotsApi* | [**deleteSnapshot**](docs/Api/SnapshotsApi.md#deletesnapshot) | **DELETE** /instance/v1/zones/{zone}/snapshots/{snapshot_id} | Delete a snapshot
*SnapshotsApi* | [**exportSnapshot**](docs/Api/SnapshotsApi.md#exportsnapshot) | **POST** /instance/v1/zones/{zone}/snapshots/{snapshot_id}/export | Export a snapshot
*SnapshotsApi* | [**getSnapshot**](docs/Api/SnapshotsApi.md#getsnapshot) | **GET** /instance/v1/zones/{zone}/snapshots/{snapshot_id} | Get a snapshot
*SnapshotsApi* | [**listSnapshots**](docs/Api/SnapshotsApi.md#listsnapshots) | **GET** /instance/v1/zones/{zone}/snapshots | List snapshots
*SnapshotsApi* | [**setSnapshot**](docs/Api/SnapshotsApi.md#setsnapshot) | **PUT** /instance/v1/zones/{zone}/snapshots/{snapshot_id} | Set snapshot
*SnapshotsApi* | [**updateSnapshot**](docs/Api/SnapshotsApi.md#updatesnapshot) | **PATCH** /instance/v1/zones/{zone}/snapshots/{snapshot_id} | Update a snapshot
*UserDataApi* | [**deleteServerUserData**](docs/Api/UserDataApi.md#deleteserveruserdata) | **DELETE** /instance/v1/zones/{zone}/servers/{server_id}/user_data/{key} | Delete user data
*UserDataApi* | [**getServerUserData**](docs/Api/UserDataApi.md#getserveruserdata) | **GET** /instance/v1/zones/{zone}/servers/{server_id}/user_data/{key} | Get user data
*UserDataApi* | [**listServerUserData**](docs/Api/UserDataApi.md#listserveruserdata) | **GET** /instance/v1/zones/{zone}/servers/{server_id}/user_data | List user data
*UserDataApi* | [**setServerUserData**](docs/Api/UserDataApi.md#setserveruserdata) | **PATCH** /instance/v1/zones/{zone}/servers/{server_id}/user_data/{key} | Add/set user data
*VolumeTypesApi* | [**listVolumesTypes**](docs/Api/VolumeTypesApi.md#listvolumestypes) | **GET** /instance/v1/zones/{zone}/products/volumes | List volume types
*VolumesApi* | [**applyBlockMigration**](docs/Api/VolumesApi.md#applyblockmigration) | **POST** /instance/v1/zones/{zone}/block-migration/apply | Migrate a volume and/or snapshots to SBS (Scaleway Block Storage)
*VolumesApi* | [**createVolume**](docs/Api/VolumesApi.md#createvolume) | **POST** /instance/v1/zones/{zone}/volumes | Create a volume
*VolumesApi* | [**deleteVolume**](docs/Api/VolumesApi.md#deletevolume) | **DELETE** /instance/v1/zones/{zone}/volumes/{volume_id} | Delete a volume
*VolumesApi* | [**getVolume**](docs/Api/VolumesApi.md#getvolume) | **GET** /instance/v1/zones/{zone}/volumes/{volume_id} | Get a volume
*VolumesApi* | [**listVolumes**](docs/Api/VolumesApi.md#listvolumes) | **GET** /instance/v1/zones/{zone}/volumes | List volumes
*VolumesApi* | [**planBlockMigration**](docs/Api/VolumesApi.md#planblockmigration) | **POST** /instance/v1/zones/{zone}/block-migration/plan | Get a volume or snapshot&#39;s migration plan
*VolumesApi* | [**setVolume**](docs/Api/VolumesApi.md#setvolume) | **PUT** /instance/v1/zones/{zone}/volumes/{id} | Update volume
*VolumesApi* | [**updateVolume**](docs/Api/VolumesApi.md#updatevolume) | **PATCH** /instance/v1/zones/{zone}/volumes/{volume_id} | Update a volume
## Models
- [ApplyBlockMigrationRequest](docs/Model/ApplyBlockMigrationRequest.md)
- [AttachServerVolumeRequest](docs/Model/AttachServerVolumeRequest.md)
- [CheckBlockMigrationOrganizationQuotasRequest](docs/Model/CheckBlockMigrationOrganizationQuotasRequest.md)
- [CreateImageRequest](docs/Model/CreateImageRequest.md)
- [CreateImageRequestExtraVolumes](docs/Model/CreateImageRequestExtraVolumes.md)
- [CreateIpRequest](docs/Model/CreateIpRequest.md)
- [CreatePlacementGroupRequest](docs/Model/CreatePlacementGroupRequest.md)
- [CreatePrivateNICRequest](docs/Model/CreatePrivateNICRequest.md)
- [CreateSecurityGroupRequest](docs/Model/CreateSecurityGroupRequest.md)
- [CreateSecurityGroupRuleRequest](docs/Model/CreateSecurityGroupRuleRequest.md)
- [CreateServerRequest](docs/Model/CreateServerRequest.md)
- [CreateServerRequestVolumes](docs/Model/CreateServerRequestVolumes.md)
- [CreateSnapshotRequest](docs/Model/CreateSnapshotRequest.md)
- [CreateVolumeRequest](docs/Model/CreateVolumeRequest.md)
- [DetachServerVolumeRequest](docs/Model/DetachServerVolumeRequest.md)
- [ExportSnapshotRequest](docs/Model/ExportSnapshotRequest.md)
- [PlanBlockMigrationRequest](docs/Model/PlanBlockMigrationRequest.md)
- [ScalewayInstanceV1Arch](docs/Model/ScalewayInstanceV1Arch.md)
- [ScalewayInstanceV1AttachServerVolumeRequestVolumeType](docs/Model/ScalewayInstanceV1AttachServerVolumeRequestVolumeType.md)
- [ScalewayInstanceV1AttachServerVolumeResponse](docs/Model/ScalewayInstanceV1AttachServerVolumeResponse.md)
- [ScalewayInstanceV1BootType](docs/Model/ScalewayInstanceV1BootType.md)
- [ScalewayInstanceV1Bootscript](docs/Model/ScalewayInstanceV1Bootscript.md)
- [ScalewayInstanceV1CreateImageResponse](docs/Model/ScalewayInstanceV1CreateImageResponse.md)
- [ScalewayInstanceV1CreateIpResponse](docs/Model/ScalewayInstanceV1CreateIpResponse.md)
- [ScalewayInstanceV1CreatePlacementGroupResponse](docs/Model/ScalewayInstanceV1CreatePlacementGroupResponse.md)
- [ScalewayInstanceV1CreatePrivateNICResponse](docs/Model/ScalewayInstanceV1CreatePrivateNICResponse.md)
- [ScalewayInstanceV1CreateSecurityGroupResponse](docs/Model/ScalewayInstanceV1CreateSecurityGroupResponse.md)
- [ScalewayInstanceV1CreateSecurityGroupRuleResponse](docs/Model/ScalewayInstanceV1CreateSecurityGroupRuleResponse.md)
- [ScalewayInstanceV1CreateServerResponse](docs/Model/ScalewayInstanceV1CreateServerResponse.md)
- [ScalewayInstanceV1CreateSnapshotResponse](docs/Model/ScalewayInstanceV1CreateSnapshotResponse.md)
- [ScalewayInstanceV1CreateVolumeResponse](docs/Model/ScalewayInstanceV1CreateVolumeResponse.md)
- [ScalewayInstanceV1Dashboard](docs/Model/ScalewayInstanceV1Dashboard.md)
- [ScalewayInstanceV1DashboardServersByTypes](docs/Model/ScalewayInstanceV1DashboardServersByTypes.md)
- [ScalewayInstanceV1DetachServerVolumeResponse](docs/Model/ScalewayInstanceV1DetachServerVolumeResponse.md)
- [ScalewayInstanceV1ExportSnapshotResponse](docs/Model/ScalewayInstanceV1ExportSnapshotResponse.md)
- [ScalewayInstanceV1GetDashboardResponse](docs/Model/ScalewayInstanceV1GetDashboardResponse.md)
- [ScalewayInstanceV1GetImageResponse](docs/Model/ScalewayInstanceV1GetImageResponse.md)
- [ScalewayInstanceV1GetIpResponse](docs/Model/ScalewayInstanceV1GetIpResponse.md)
- [ScalewayInstanceV1GetPlacementGroupResponse](docs/Model/ScalewayInstanceV1GetPlacementGroupResponse.md)
- [ScalewayInstanceV1GetPlacementGroupServersResponse](docs/Model/ScalewayInstanceV1GetPlacementGroupServersResponse.md)
- [ScalewayInstanceV1GetPrivateNICResponse](docs/Model/ScalewayInstanceV1GetPrivateNICResponse.md)
- [ScalewayInstanceV1GetSecurityGroupResponse](docs/Model/ScalewayInstanceV1GetSecurityGroupResponse.md)
- [ScalewayInstanceV1GetSecurityGroupRuleResponse](docs/Model/ScalewayInstanceV1GetSecurityGroupRuleResponse.md)
- [ScalewayInstanceV1GetServerResponse](docs/Model/ScalewayInstanceV1GetServerResponse.md)
- [ScalewayInstanceV1GetServerTypesAvailabilityResponse](docs/Model/ScalewayInstanceV1GetServerTypesAvailabilityResponse.md)
- [ScalewayInstanceV1GetServerTypesAvailabilityResponseAvailability](docs/Model/ScalewayInstanceV1GetServerTypesAvailabilityResponseAvailability.md)
- [ScalewayInstanceV1GetServerTypesAvailabilityResponseServers](docs/Model/ScalewayInstanceV1GetServerTypesAvailabilityResponseServers.md)
- [ScalewayInstanceV1GetSnapshotResponse](docs/Model/ScalewayInstanceV1GetSnapshotResponse.md)
- [ScalewayInstanceV1GetVolumeResponse](docs/Model/ScalewayInstanceV1GetVolumeResponse.md)
- [ScalewayInstanceV1Image](docs/Model/ScalewayInstanceV1Image.md)
- [ScalewayInstanceV1ImageState](docs/Model/ScalewayInstanceV1ImageState.md)
- [ScalewayInstanceV1Ip](docs/Model/ScalewayInstanceV1Ip.md)
- [ScalewayInstanceV1IpState](docs/Model/ScalewayInstanceV1IpState.md)
- [ScalewayInstanceV1IpType](docs/Model/ScalewayInstanceV1IpType.md)
- [ScalewayInstanceV1ListImagesResponse](docs/Model/ScalewayInstanceV1ListImagesResponse.md)
- [ScalewayInstanceV1ListIpsResponse](docs/Model/ScalewayInstanceV1ListIpsResponse.md)
- [ScalewayInstanceV1ListPlacementGroupsResponse](docs/Model/ScalewayInstanceV1ListPlacementGroupsResponse.md)
- [ScalewayInstanceV1ListPrivateNICsResponse](docs/Model/ScalewayInstanceV1ListPrivateNICsResponse.md)
- [ScalewayInstanceV1ListSecurityGroupRulesResponse](docs/Model/ScalewayInstanceV1ListSecurityGroupRulesResponse.md)
- [ScalewayInstanceV1ListSecurityGroupsResponse](docs/Model/ScalewayInstanceV1ListSecurityGroupsResponse.md)
- [ScalewayInstanceV1ListServerActionsResponse](docs/Model/ScalewayInstanceV1ListServerActionsResponse.md)
- [ScalewayInstanceV1ListServerUserDataResponse](docs/Model/ScalewayInstanceV1ListServerUserDataResponse.md)
- [ScalewayInstanceV1ListServersResponse](docs/Model/ScalewayInstanceV1ListServersResponse.md)
- [ScalewayInstanceV1ListServersTypesResponse](docs/Model/ScalewayInstanceV1ListServersTypesResponse.md)
- [ScalewayInstanceV1ListServersTypesResponseServers](docs/Model/ScalewayInstanceV1ListServersTypesResponseServers.md)
- [ScalewayInstanceV1ListSnapshotsResponse](docs/Model/ScalewayInstanceV1ListSnapshotsResponse.md)
- [ScalewayInstanceV1ListVolumesResponse](docs/Model/ScalewayInstanceV1ListVolumesResponse.md)
- [ScalewayInstanceV1ListVolumesTypesResponse](docs/Model/ScalewayInstanceV1ListVolumesTypesResponse.md)
- [ScalewayInstanceV1ListVolumesTypesResponseVolumes](docs/Model/ScalewayInstanceV1ListVolumesTypesResponseVolumes.md)
- [ScalewayInstanceV1MigrationPlan](docs/Model/ScalewayInstanceV1MigrationPlan.md)
- [ScalewayInstanceV1MigrationPlanVolume](docs/Model/ScalewayInstanceV1MigrationPlanVolume.md)
- [ScalewayInstanceV1PlacementGroup](docs/Model/ScalewayInstanceV1PlacementGroup.md)
- [ScalewayInstanceV1PlacementGroupPolicyMode](docs/Model/ScalewayInstanceV1PlacementGroupPolicyMode.md)
- [ScalewayInstanceV1PlacementGroupPolicyType](docs/Model/ScalewayInstanceV1PlacementGroupPolicyType.md)
- [ScalewayInstanceV1PlacementGroupServer](docs/Model/ScalewayInstanceV1PlacementGroupServer.md)
- [ScalewayInstanceV1PrivateNIC](docs/Model/ScalewayInstanceV1PrivateNIC.md)
- [ScalewayInstanceV1SecurityGroup](docs/Model/ScalewayInstanceV1SecurityGroup.md)
- [ScalewayInstanceV1SecurityGroupRule](docs/Model/ScalewayInstanceV1SecurityGroupRule.md)
- [ScalewayInstanceV1SecurityGroupRuleAction](docs/Model/ScalewayInstanceV1SecurityGroupRuleAction.md)
- [ScalewayInstanceV1SecurityGroupRuleDirection](docs/Model/ScalewayInstanceV1SecurityGroupRuleDirection.md)
- [ScalewayInstanceV1SecurityGroupRuleProtocol](docs/Model/ScalewayInstanceV1SecurityGroupRuleProtocol.md)
- [ScalewayInstanceV1SecurityGroupTemplate](docs/Model/ScalewayInstanceV1SecurityGroupTemplate.md)
- [ScalewayInstanceV1Server](docs/Model/ScalewayInstanceV1Server.md)
- [ScalewayInstanceV1ServerAction](docs/Model/ScalewayInstanceV1ServerAction.md)
- [ScalewayInstanceV1ServerActionRequestVolumeBackupTemplate](docs/Model/ScalewayInstanceV1ServerActionRequestVolumeBackupTemplate.md)
- [ScalewayInstanceV1ServerActionResponse](docs/Model/ScalewayInstanceV1ServerActionResponse.md)
- [ScalewayInstanceV1ServerImage](docs/Model/ScalewayInstanceV1ServerImage.md)
- [ScalewayInstanceV1ServerIp](docs/Model/ScalewayInstanceV1ServerIp.md)
- [ScalewayInstanceV1ServerIpv6](docs/Model/ScalewayInstanceV1ServerIpv6.md)
- [ScalewayInstanceV1ServerLocation](docs/Model/ScalewayInstanceV1ServerLocation.md)
- [ScalewayInstanceV1ServerMaintenance](docs/Model/ScalewayInstanceV1ServerMaintenance.md)
- [ScalewayInstanceV1ServerPlacementGroup](docs/Model/ScalewayInstanceV1ServerPlacementGroup.md)
- [ScalewayInstanceV1ServerPublicIp](docs/Model/ScalewayInstanceV1ServerPublicIp.md)
- [ScalewayInstanceV1ServerSecurityGroup](docs/Model/ScalewayInstanceV1ServerSecurityGroup.md)
- [ScalewayInstanceV1ServerSummary](docs/Model/ScalewayInstanceV1ServerSummary.md)
- [ScalewayInstanceV1ServerType](docs/Model/ScalewayInstanceV1ServerType.md)
- [ScalewayInstanceV1ServerTypeCapabilities](docs/Model/ScalewayInstanceV1ServerTypeCapabilities.md)
- [ScalewayInstanceV1ServerTypeNetwork](docs/Model/ScalewayInstanceV1ServerTypeNetwork.md)
- [ScalewayInstanceV1ServerTypeNetworkInterface](docs/Model/ScalewayInstanceV1ServerTypeNetworkInterface.md)
- [ScalewayInstanceV1ServerTypePerVolumeConstraint](docs/Model/ScalewayInstanceV1ServerTypePerVolumeConstraint.md)
- [ScalewayInstanceV1ServerTypePerVolumeConstraintLSsd](docs/Model/ScalewayInstanceV1ServerTypePerVolumeConstraintLSsd.md)
- [ScalewayInstanceV1ServerTypeVolumesConstraint](docs/Model/ScalewayInstanceV1ServerTypeVolumesConstraint.md)
- [ScalewayInstanceV1ServerTypesAvailability](docs/Model/ScalewayInstanceV1ServerTypesAvailability.md)
- [ScalewayInstanceV1ServerVolumes](docs/Model/ScalewayInstanceV1ServerVolumes.md)
- [ScalewayInstanceV1SetImageResponse](docs/Model/ScalewayInstanceV1SetImageResponse.md)
- [ScalewayInstanceV1SetPlacementGroupResponse](docs/Model/ScalewayInstanceV1SetPlacementGroupResponse.md)
- [ScalewayInstanceV1SetPlacementGroupServersResponse](docs/Model/ScalewayInstanceV1SetPlacementGroupServersResponse.md)
- [ScalewayInstanceV1SetSecurityGroupResponse](docs/Model/ScalewayInstanceV1SetSecurityGroupResponse.md)
- [ScalewayInstanceV1SetSecurityGroupRuleResponse](docs/Model/ScalewayInstanceV1SetSecurityGroupRuleResponse.md)
- [ScalewayInstanceV1SetSecurityGroupRulesRequestRule](docs/Model/ScalewayInstanceV1SetSecurityGroupRulesRequestRule.md)
- [ScalewayInstanceV1SetSecurityGroupRulesResponse](docs/Model/ScalewayInstanceV1SetSecurityGroupRulesResponse.md)
- [ScalewayInstanceV1SetSnapshotResponse](docs/Model/ScalewayInstanceV1SetSnapshotResponse.md)
- [ScalewayInstanceV1SetVolumeResponse](docs/Model/ScalewayInstanceV1SetVolumeResponse.md)
- [ScalewayInstanceV1Snapshot](docs/Model/ScalewayInstanceV1Snapshot.md)
- [ScalewayInstanceV1SnapshotBaseVolume](docs/Model/ScalewayInstanceV1SnapshotBaseVolume.md)
- [ScalewayInstanceV1SnapshotState](docs/Model/ScalewayInstanceV1SnapshotState.md)
- [ScalewayInstanceV1Task](docs/Model/ScalewayInstanceV1Task.md)
- [ScalewayInstanceV1UpdateImageResponse](docs/Model/ScalewayInstanceV1UpdateImageResponse.md)
- [ScalewayInstanceV1UpdateIpResponse](docs/Model/ScalewayInstanceV1UpdateIpResponse.md)
- [ScalewayInstanceV1UpdatePlacementGroupResponse](docs/Model/ScalewayInstanceV1UpdatePlacementGroupResponse.md)
- [ScalewayInstanceV1UpdatePlacementGroupServersResponse](docs/Model/ScalewayInstanceV1UpdatePlacementGroupServersResponse.md)
- [ScalewayInstanceV1UpdateSecurityGroupResponse](docs/Model/ScalewayInstanceV1UpdateSecurityGroupResponse.md)
- [ScalewayInstanceV1UpdateSecurityGroupRuleResponse](docs/Model/ScalewayInstanceV1UpdateSecurityGroupRuleResponse.md)
- [ScalewayInstanceV1UpdateServerResponse](docs/Model/ScalewayInstanceV1UpdateServerResponse.md)
- [ScalewayInstanceV1UpdateSnapshotResponse](docs/Model/ScalewayInstanceV1UpdateSnapshotResponse.md)
- [ScalewayInstanceV1UpdateVolumeResponse](docs/Model/ScalewayInstanceV1UpdateVolumeResponse.md)
- [ScalewayInstanceV1Volume](docs/Model/ScalewayInstanceV1Volume.md)
- [ScalewayInstanceV1VolumeImageUpdateTemplate](docs/Model/ScalewayInstanceV1VolumeImageUpdateTemplate.md)
- [ScalewayInstanceV1VolumeServer](docs/Model/ScalewayInstanceV1VolumeServer.md)
- [ScalewayInstanceV1VolumeServerState](docs/Model/ScalewayInstanceV1VolumeServerState.md)
- [ScalewayInstanceV1VolumeServerTemplate](docs/Model/ScalewayInstanceV1VolumeServerTemplate.md)
- [ScalewayInstanceV1VolumeServerVolumeType](docs/Model/ScalewayInstanceV1VolumeServerVolumeType.md)
- [ScalewayInstanceV1VolumeSummary](docs/Model/ScalewayInstanceV1VolumeSummary.md)
- [ScalewayInstanceV1VolumeTemplate](docs/Model/ScalewayInstanceV1VolumeTemplate.md)
- [ScalewayInstanceV1VolumeType](docs/Model/ScalewayInstanceV1VolumeType.md)
- [ScalewayInstanceV1VolumeTypeCapabilities](docs/Model/ScalewayInstanceV1VolumeTypeCapabilities.md)
- [ScalewayInstanceV1VolumeTypeConstraints](docs/Model/ScalewayInstanceV1VolumeTypeConstraints.md)
- [ScalewayInstanceV1VolumeVolumeType](docs/Model/ScalewayInstanceV1VolumeVolumeType.md)
- [ScalewayStdFile](docs/Model/ScalewayStdFile.md)
- [ServerActionRequest](docs/Model/ServerActionRequest.md)
- [ServerActionRequestVolumes](docs/Model/ServerActionRequestVolumes.md)
- [SetImageRequest](docs/Model/SetImageRequest.md)
- [SetImageRequestExtraVolumes](docs/Model/SetImageRequestExtraVolumes.md)
- [SetPlacementGroupRequest](docs/Model/SetPlacementGroupRequest.md)
- [SetPlacementGroupServersRequest](docs/Model/SetPlacementGroupServersRequest.md)
- [SetSecurityGroupRequest](docs/Model/SetSecurityGroupRequest.md)
- [SetSecurityGroupRuleRequest](docs/Model/SetSecurityGroupRuleRequest.md)
- [SetSecurityGroupRulesRequest](docs/Model/SetSecurityGroupRulesRequest.md)
- [SetSnapshotRequest](docs/Model/SetSnapshotRequest.md)
- [SetVolumeRequest](docs/Model/SetVolumeRequest.md)
- [SetVolumeRequestServer](docs/Model/SetVolumeRequestServer.md)
- [UpdateImageRequest](docs/Model/UpdateImageRequest.md)
- [UpdateImageRequestExtraVolumes](docs/Model/UpdateImageRequestExtraVolumes.md)
- [UpdateIpRequest](docs/Model/UpdateIpRequest.md)
- [UpdatePlacementGroupRequest](docs/Model/UpdatePlacementGroupRequest.md)
- [UpdatePrivateNICRequest](docs/Model/UpdatePrivateNICRequest.md)
- [UpdateSecurityGroupRequest](docs/Model/UpdateSecurityGroupRequest.md)
- [UpdateSecurityGroupRuleRequest](docs/Model/UpdateSecurityGroupRuleRequest.md)
- [UpdateServerRequest](docs/Model/UpdateServerRequest.md)
- [UpdateServerRequestVolumes](docs/Model/UpdateServerRequestVolumes.md)
- [UpdateSnapshotRequest](docs/Model/UpdateSnapshotRequest.md)
- [UpdateVolumeRequest](docs/Model/UpdateVolumeRequest.md)
## Authorization
Authentication schemes defined for the API:
### scaleway
- **Type**: API key
- **API key parameter name**: X-Auth-Token
- **Location**: HTTP header
## Tests
To run the tests, use:
```bash
composer install
vendor/bin/phpunit
```
## Author
## About this package
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: `v1`
- Generator version: `7.11.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`

38
composer.json Normal file

File diff suppressed because one or more lines are too long

264
docs/Api/DefaultApi.md Normal file
View file

@ -0,0 +1,264 @@
# OpenAPI\Client\DefaultApi
All URIs are relative to https://api.scaleway.com, except if the operation defines another base path.
| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**attachServerVolume()**](DefaultApi.md#attachServerVolume) | **POST** /instance/v1/zones/{zone}/servers/{server_id}/attach-volume | |
| [**checkBlockMigrationOrganizationQuotas()**](DefaultApi.md#checkBlockMigrationOrganizationQuotas) | **POST** /instance/v1/zones/{zone}/block-migration/check-organization-quotas | |
| [**detachServerVolume()**](DefaultApi.md#detachServerVolume) | **POST** /instance/v1/zones/{zone}/servers/{server_id}/detach-volume | |
| [**getDashboard()**](DefaultApi.md#getDashboard) | **GET** /instance/v1/zones/{zone}/dashboard | |
## `attachServerVolume()`
```php
attachServerVolume($zone, $server_id, $attach_server_volume_request): \OpenAPI\Client\Model\ScalewayInstanceV1AttachServerVolumeResponse
```
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\DefaultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$server_id = 'server_id_example'; // string
$attach_server_volume_request = new \OpenAPI\Client\Model\AttachServerVolumeRequest(); // \OpenAPI\Client\Model\AttachServerVolumeRequest
try {
$result = $apiInstance->attachServerVolume($zone, $server_id, $attach_server_volume_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->attachServerVolume: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **server_id** | **string**| | |
| **attach_server_volume_request** | [**\OpenAPI\Client\Model\AttachServerVolumeRequest**](../Model/AttachServerVolumeRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1AttachServerVolumeResponse**](../Model/ScalewayInstanceV1AttachServerVolumeResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `checkBlockMigrationOrganizationQuotas()`
```php
checkBlockMigrationOrganizationQuotas($zone, $check_block_migration_organization_quotas_request)
```
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\DefaultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$check_block_migration_organization_quotas_request = new \OpenAPI\Client\Model\CheckBlockMigrationOrganizationQuotasRequest(); // \OpenAPI\Client\Model\CheckBlockMigrationOrganizationQuotasRequest
try {
$apiInstance->checkBlockMigrationOrganizationQuotas($zone, $check_block_migration_organization_quotas_request);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->checkBlockMigrationOrganizationQuotas: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **check_block_migration_organization_quotas_request** | [**\OpenAPI\Client\Model\CheckBlockMigrationOrganizationQuotasRequest**](../Model/CheckBlockMigrationOrganizationQuotasRequest.md)| | |
### Return type
void (empty response body)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `detachServerVolume()`
```php
detachServerVolume($zone, $server_id, $detach_server_volume_request): \OpenAPI\Client\Model\ScalewayInstanceV1DetachServerVolumeResponse
```
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\DefaultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$server_id = 'server_id_example'; // string
$detach_server_volume_request = new \OpenAPI\Client\Model\DetachServerVolumeRequest(); // \OpenAPI\Client\Model\DetachServerVolumeRequest
try {
$result = $apiInstance->detachServerVolume($zone, $server_id, $detach_server_volume_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->detachServerVolume: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **server_id** | **string**| | |
| **detach_server_volume_request** | [**\OpenAPI\Client\Model\DetachServerVolumeRequest**](../Model/DetachServerVolumeRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1DetachServerVolumeResponse**](../Model/ScalewayInstanceV1DetachServerVolumeResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `getDashboard()`
```php
getDashboard($zone, $organization, $project): \OpenAPI\Client\Model\ScalewayInstanceV1GetDashboardResponse
```
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\DefaultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$organization = 'organization_example'; // string
$project = 'project_example'; // string
try {
$result = $apiInstance->getDashboard($zone, $organization, $project);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->getDashboard: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **organization** | **string**| | [optional] |
| **project** | **string**| | [optional] |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1GetDashboardResponse**](../Model/ScalewayInstanceV1GetDashboardResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

345
docs/Api/IPsApi.md Normal file
View file

@ -0,0 +1,345 @@
# OpenAPI\Client\IPsApi
All URIs are relative to https://api.scaleway.com, except if the operation defines another base path.
| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**createIp()**](IPsApi.md#createIp) | **POST** /instance/v1/zones/{zone}/ips | Reserve a flexible IP |
| [**deleteIp()**](IPsApi.md#deleteIp) | **DELETE** /instance/v1/zones/{zone}/ips/{ip} | Delete a flexible IP |
| [**getIp()**](IPsApi.md#getIp) | **GET** /instance/v1/zones/{zone}/ips/{ip} | Get a flexible IP |
| [**listIps()**](IPsApi.md#listIps) | **GET** /instance/v1/zones/{zone}/ips | List all flexible IPs |
| [**updateIp()**](IPsApi.md#updateIp) | **PATCH** /instance/v1/zones/{zone}/ips/{ip} | Update a flexible IP |
## `createIp()`
```php
createIp($zone, $create_ip_request): \OpenAPI\Client\Model\ScalewayInstanceV1CreateIpResponse
```
Reserve a flexible IP
Reserve a flexible IP and attach it to the specified Instance.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\IPsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$create_ip_request = new \OpenAPI\Client\Model\CreateIpRequest(); // \OpenAPI\Client\Model\CreateIpRequest
try {
$result = $apiInstance->createIp($zone, $create_ip_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling IPsApi->createIp: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **create_ip_request** | [**\OpenAPI\Client\Model\CreateIpRequest**](../Model/CreateIpRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1CreateIpResponse**](../Model/ScalewayInstanceV1CreateIpResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `deleteIp()`
```php
deleteIp($zone, $ip)
```
Delete a flexible IP
Delete the IP with the specified ID.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\IPsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$ip = 'ip_example'; // string | ID or address of the IP to delete.
try {
$apiInstance->deleteIp($zone, $ip);
} catch (Exception $e) {
echo 'Exception when calling IPsApi->deleteIp: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **ip** | **string**| ID or address of the IP to delete. | |
### Return type
void (empty response body)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `getIp()`
```php
getIp($zone, $ip): \OpenAPI\Client\Model\ScalewayInstanceV1GetIpResponse
```
Get a flexible IP
Get details of an IP with the specified ID or address.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\IPsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$ip = 'ip_example'; // string | IP ID or address to get.
try {
$result = $apiInstance->getIp($zone, $ip);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling IPsApi->getIp: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **ip** | **string**| IP ID or address to get. | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1GetIpResponse**](../Model/ScalewayInstanceV1GetIpResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `listIps()`
```php
listIps($zone, $project, $organization, $tags, $name, $per_page, $page, $type): \OpenAPI\Client\Model\ScalewayInstanceV1ListIpsResponse
```
List all flexible IPs
List all flexible IPs in a specified zone.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\IPsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$project = 'project_example'; // string | Project ID in which the IPs are reserved.
$organization = 'organization_example'; // string | Organization ID in which the IPs are reserved.
$tags = 'tags_example'; // string | Filter IPs with these exact tags (to filter with several tags, use commas to separate them).
$name = 'name_example'; // string | Filter on the IP address (Works as a LIKE operation on the IP address).
$per_page = 56; // int | A positive integer lower or equal to 100 to select the number of items to return.
$page = 56; // int | A positive integer to choose the page to return.
$type = 'type_example'; // string | Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6').
try {
$result = $apiInstance->listIps($zone, $project, $organization, $tags, $name, $per_page, $page, $type);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling IPsApi->listIps: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **project** | **string**| Project ID in which the IPs are reserved. | [optional] |
| **organization** | **string**| Organization ID in which the IPs are reserved. | [optional] |
| **tags** | **string**| Filter IPs with these exact tags (to filter with several tags, use commas to separate them). | [optional] |
| **name** | **string**| Filter on the IP address (Works as a LIKE operation on the IP address). | [optional] |
| **per_page** | **int**| A positive integer lower or equal to 100 to select the number of items to return. | [optional] |
| **page** | **int**| A positive integer to choose the page to return. | [optional] |
| **type** | **string**| Filter on the IP Mobility IP type (whose value should be either &#39;routed_ipv4&#39; or &#39;routed_ipv6&#39;). | [optional] |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1ListIpsResponse**](../Model/ScalewayInstanceV1ListIpsResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `updateIp()`
```php
updateIp($zone, $ip, $update_ip_request): \OpenAPI\Client\Model\ScalewayInstanceV1UpdateIpResponse
```
Update a flexible IP
Update a flexible IP in the specified zone with the specified ID.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\IPsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$ip = 'ip_example'; // string | IP ID or IP address.
$update_ip_request = new \OpenAPI\Client\Model\UpdateIpRequest(); // \OpenAPI\Client\Model\UpdateIpRequest
try {
$result = $apiInstance->updateIp($zone, $ip, $update_ip_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling IPsApi->updateIp: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **ip** | **string**| IP ID or IP address. | |
| **update_ip_request** | [**\OpenAPI\Client\Model\UpdateIpRequest**](../Model/UpdateIpRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1UpdateIpResponse**](../Model/ScalewayInstanceV1UpdateIpResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

414
docs/Api/ImagesApi.md Normal file
View file

@ -0,0 +1,414 @@
# OpenAPI\Client\ImagesApi
All URIs are relative to https://api.scaleway.com, except if the operation defines another base path.
| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**createImage()**](ImagesApi.md#createImage) | **POST** /instance/v1/zones/{zone}/images | Create an Instance image |
| [**deleteImage()**](ImagesApi.md#deleteImage) | **DELETE** /instance/v1/zones/{zone}/images/{image_id} | Delete an Instance image |
| [**getImage()**](ImagesApi.md#getImage) | **GET** /instance/v1/zones/{zone}/images/{image_id} | Get an Instance image |
| [**listImages()**](ImagesApi.md#listImages) | **GET** /instance/v1/zones/{zone}/images | List Instance images |
| [**setImage()**](ImagesApi.md#setImage) | **PUT** /instance/v1/zones/{zone}/images/{id} | Update image |
| [**updateImage()**](ImagesApi.md#updateImage) | **PATCH** /instance/v1/zones/{zone}/images/{image_id} | Update image |
## `createImage()`
```php
createImage($zone, $create_image_request): \OpenAPI\Client\Model\ScalewayInstanceV1CreateImageResponse
```
Create an Instance image
Create an Instance image from the specified snapshot ID.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\ImagesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$create_image_request = new \OpenAPI\Client\Model\CreateImageRequest(); // \OpenAPI\Client\Model\CreateImageRequest
try {
$result = $apiInstance->createImage($zone, $create_image_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ImagesApi->createImage: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **create_image_request** | [**\OpenAPI\Client\Model\CreateImageRequest**](../Model/CreateImageRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1CreateImageResponse**](../Model/ScalewayInstanceV1CreateImageResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `deleteImage()`
```php
deleteImage($zone, $image_id)
```
Delete an Instance image
Delete the image with the specified ID.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\ImagesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$image_id = 'image_id_example'; // string | UUID of the image you want to delete.
try {
$apiInstance->deleteImage($zone, $image_id);
} catch (Exception $e) {
echo 'Exception when calling ImagesApi->deleteImage: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **image_id** | **string**| UUID of the image you want to delete. | |
### Return type
void (empty response body)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `getImage()`
```php
getImage($zone, $image_id): \OpenAPI\Client\Model\ScalewayInstanceV1GetImageResponse
```
Get an Instance image
Get details of an image with the specified ID.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\ImagesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$image_id = 'image_id_example'; // string | UUID of the image you want to get.
try {
$result = $apiInstance->getImage($zone, $image_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ImagesApi->getImage: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **image_id** | **string**| UUID of the image you want to get. | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1GetImageResponse**](../Model/ScalewayInstanceV1GetImageResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `listImages()`
```php
listImages($zone, $organization, $per_page, $page, $name, $public, $arch, $project, $tags): \OpenAPI\Client\Model\ScalewayInstanceV1ListImagesResponse
```
List Instance images
List all existing Instance images.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\ImagesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$organization = 'organization_example'; // string
$per_page = 56; // int
$page = 56; // int
$name = 'name_example'; // string
$public = True; // bool
$arch = 'arch_example'; // string
$project = 'project_example'; // string
$tags = 'tags_example'; // string
try {
$result = $apiInstance->listImages($zone, $organization, $per_page, $page, $name, $public, $arch, $project, $tags);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ImagesApi->listImages: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **organization** | **string**| | [optional] |
| **per_page** | **int**| | [optional] |
| **page** | **int**| | [optional] |
| **name** | **string**| | [optional] |
| **public** | **bool**| | [optional] |
| **arch** | **string**| | [optional] |
| **project** | **string**| | [optional] |
| **tags** | **string**| | [optional] |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1ListImagesResponse**](../Model/ScalewayInstanceV1ListImagesResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `setImage()`
```php
setImage($zone, $id, $set_image_request): \OpenAPI\Client\Model\ScalewayInstanceV1SetImageResponse
```
Update image
Replace all image properties with an image message.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\ImagesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$id = 'id_example'; // string
$set_image_request = new \OpenAPI\Client\Model\SetImageRequest(); // \OpenAPI\Client\Model\SetImageRequest
try {
$result = $apiInstance->setImage($zone, $id, $set_image_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ImagesApi->setImage: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **id** | **string**| | |
| **set_image_request** | [**\OpenAPI\Client\Model\SetImageRequest**](../Model/SetImageRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1SetImageResponse**](../Model/ScalewayInstanceV1SetImageResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `updateImage()`
```php
updateImage($zone, $image_id, $update_image_request): \OpenAPI\Client\Model\ScalewayInstanceV1UpdateImageResponse
```
Update image
Update the properties of an image.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\ImagesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$image_id = 6170692e-7363-616c-6577-61792e636f6d; // string | UUID of the image. (UUID format)
$update_image_request = new \OpenAPI\Client\Model\UpdateImageRequest(); // \OpenAPI\Client\Model\UpdateImageRequest
try {
$result = $apiInstance->updateImage($zone, $image_id, $update_image_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ImagesApi->updateImage: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **image_id** | **string**| UUID of the image. (UUID format) | |
| **update_image_request** | [**\OpenAPI\Client\Model\UpdateImageRequest**](../Model/UpdateImageRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1UpdateImageResponse**](../Model/ScalewayInstanceV1UpdateImageResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

View file

@ -0,0 +1,141 @@
# OpenAPI\Client\InstanceTypesApi
All URIs are relative to https://api.scaleway.com, except if the operation defines another base path.
| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**getServerTypesAvailability()**](InstanceTypesApi.md#getServerTypesAvailability) | **GET** /instance/v1/zones/{zone}/products/servers/availability | Get availability |
| [**listServersTypes()**](InstanceTypesApi.md#listServersTypes) | **GET** /instance/v1/zones/{zone}/products/servers | List Instance types |
## `getServerTypesAvailability()`
```php
getServerTypesAvailability($zone, $per_page, $page): \OpenAPI\Client\Model\ScalewayInstanceV1GetServerTypesAvailabilityResponse
```
Get availability
Get availability for all Instance types.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\InstanceTypesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$per_page = 56; // int | A positive integer lower or equal to 100 to select the number of items to return.
$page = 56; // int | A positive integer to choose the page to return.
try {
$result = $apiInstance->getServerTypesAvailability($zone, $per_page, $page);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling InstanceTypesApi->getServerTypesAvailability: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **per_page** | **int**| A positive integer lower or equal to 100 to select the number of items to return. | [optional] |
| **page** | **int**| A positive integer to choose the page to return. | [optional] |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1GetServerTypesAvailabilityResponse**](../Model/ScalewayInstanceV1GetServerTypesAvailabilityResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `listServersTypes()`
```php
listServersTypes($zone, $per_page, $page): \OpenAPI\Client\Model\ScalewayInstanceV1ListServersTypesResponse
```
List Instance types
List available Instance types and their technical details.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\InstanceTypesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$per_page = 56; // int
$page = 56; // int
try {
$result = $apiInstance->listServersTypes($zone, $per_page, $page);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling InstanceTypesApi->listServersTypes: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **per_page** | **int**| | [optional] |
| **page** | **int**| | [optional] |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1ListServersTypesResponse**](../Model/ScalewayInstanceV1ListServersTypesResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

495
docs/Api/InstancesApi.md Normal file
View file

@ -0,0 +1,495 @@
# OpenAPI\Client\InstancesApi
All URIs are relative to https://api.scaleway.com, except if the operation defines another base path.
| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**createServer()**](InstancesApi.md#createServer) | **POST** /instance/v1/zones/{zone}/servers | Create an Instance |
| [**deleteServer()**](InstancesApi.md#deleteServer) | **DELETE** /instance/v1/zones/{zone}/servers/{server_id} | Delete an Instance |
| [**getServer()**](InstancesApi.md#getServer) | **GET** /instance/v1/zones/{zone}/servers/{server_id} | Get an Instance |
| [**listServerActions()**](InstancesApi.md#listServerActions) | **GET** /instance/v1/zones/{zone}/servers/{server_id}/action | List Instance actions |
| [**listServers()**](InstancesApi.md#listServers) | **GET** /instance/v1/zones/{zone}/servers | List all Instances |
| [**serverAction()**](InstancesApi.md#serverAction) | **POST** /instance/v1/zones/{zone}/servers/{server_id}/action | Perform action |
| [**updateServer()**](InstancesApi.md#updateServer) | **PATCH** /instance/v1/zones/{zone}/servers/{server_id} | Update an Instance |
## `createServer()`
```php
createServer($zone, $create_server_request): \OpenAPI\Client\Model\ScalewayInstanceV1CreateServerResponse
```
Create an Instance
Create a new Instance of the specified commercial type in the specified zone. Pay attention to the volumes parameter, which takes an object which can be used in different ways to achieve different behaviors. Get more information in the [Technical Information](#technical-information) section of the introduction.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\InstancesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$create_server_request = new \OpenAPI\Client\Model\CreateServerRequest(); // \OpenAPI\Client\Model\CreateServerRequest
try {
$result = $apiInstance->createServer($zone, $create_server_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling InstancesApi->createServer: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **create_server_request** | [**\OpenAPI\Client\Model\CreateServerRequest**](../Model/CreateServerRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1CreateServerResponse**](../Model/ScalewayInstanceV1CreateServerResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `deleteServer()`
```php
deleteServer($zone, $server_id)
```
Delete an Instance
Delete the Instance with the specified ID.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\InstancesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$server_id = 'server_id_example'; // string
try {
$apiInstance->deleteServer($zone, $server_id);
} catch (Exception $e) {
echo 'Exception when calling InstancesApi->deleteServer: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **server_id** | **string**| | |
### Return type
void (empty response body)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `getServer()`
```php
getServer($zone, $server_id): \OpenAPI\Client\Model\ScalewayInstanceV1GetServerResponse
```
Get an Instance
Get the details of a specified Instance.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\InstancesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$server_id = 'server_id_example'; // string | UUID of the Instance you want to get.
try {
$result = $apiInstance->getServer($zone, $server_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling InstancesApi->getServer: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **server_id** | **string**| UUID of the Instance you want to get. | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1GetServerResponse**](../Model/ScalewayInstanceV1GetServerResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `listServerActions()`
```php
listServerActions($zone, $server_id): \OpenAPI\Client\Model\ScalewayInstanceV1ListServerActionsResponse
```
List Instance actions
List all actions (e.g. power on, power off, reboot) that can currently be performed on an Instance.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\InstancesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$server_id = 'server_id_example'; // string
try {
$result = $apiInstance->listServerActions($zone, $server_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling InstancesApi->listServerActions: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **server_id** | **string**| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1ListServerActionsResponse**](../Model/ScalewayInstanceV1ListServerActionsResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `listServers()`
```php
listServers($zone, $per_page, $page, $organization, $project, $name, $private_ip, $without_ip, $with_ip, $commercial_type, $state, $tags, $private_network, $order, $private_networks, $private_nic_mac_address, $servers): \OpenAPI\Client\Model\ScalewayInstanceV1ListServersResponse
```
List all Instances
List all Instances in a specified Availability Zone, e.g. `fr-par-1`.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\InstancesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$per_page = 56; // int | A positive integer lower or equal to 100 to select the number of items to return.
$page = 56; // int | A positive integer to choose the page to return.
$organization = 'organization_example'; // string | List only Instances of this Organization ID.
$project = 'project_example'; // string | List only Instances of this Project ID.
$name = 'name_example'; // string | Filter Instances by name (eg. \"server1\" will return \"server100\" and \"server1\" but not \"foo\").
$private_ip = 1.2.3.4; // string | List Instances by private_ip. (IP address)
$without_ip = True; // bool | List Instances that are not attached to a public IP.
$with_ip = 1.2.3.4; // string | List Instances by IP (both private_ip and public_ip are supported). (IP address)
$commercial_type = 'commercial_type_example'; // string | List Instances of this commercial type.
$state = 'running'; // string | List Instances in this state.
$tags = 'tags_example'; // string | List Instances with these exact tags (to filter with several tags, use commas to separate them).
$private_network = 'private_network_example'; // string | List Instances in this Private Network.
$order = 'creation_date_desc'; // string | Define the order of the returned servers.
$private_networks = 'private_networks_example'; // string | List Instances from the given Private Networks (use commas to separate them).
$private_nic_mac_address = 'private_nic_mac_address_example'; // string | List Instances associated with the given private NIC MAC address.
$servers = 'servers_example'; // string | List Instances from these server ids (use commas to separate them).
try {
$result = $apiInstance->listServers($zone, $per_page, $page, $organization, $project, $name, $private_ip, $without_ip, $with_ip, $commercial_type, $state, $tags, $private_network, $order, $private_networks, $private_nic_mac_address, $servers);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling InstancesApi->listServers: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **per_page** | **int**| A positive integer lower or equal to 100 to select the number of items to return. | [optional] |
| **page** | **int**| A positive integer to choose the page to return. | [optional] |
| **organization** | **string**| List only Instances of this Organization ID. | [optional] |
| **project** | **string**| List only Instances of this Project ID. | [optional] |
| **name** | **string**| Filter Instances by name (eg. \&quot;server1\&quot; will return \&quot;server100\&quot; and \&quot;server1\&quot; but not \&quot;foo\&quot;). | [optional] |
| **private_ip** | **string**| List Instances by private_ip. (IP address) | [optional] |
| **without_ip** | **bool**| List Instances that are not attached to a public IP. | [optional] |
| **with_ip** | **string**| List Instances by IP (both private_ip and public_ip are supported). (IP address) | [optional] |
| **commercial_type** | **string**| List Instances of this commercial type. | [optional] |
| **state** | **string**| List Instances in this state. | [optional] [default to &#39;running&#39;] |
| **tags** | **string**| List Instances with these exact tags (to filter with several tags, use commas to separate them). | [optional] |
| **private_network** | **string**| List Instances in this Private Network. | [optional] |
| **order** | **string**| Define the order of the returned servers. | [optional] [default to &#39;creation_date_desc&#39;] |
| **private_networks** | **string**| List Instances from the given Private Networks (use commas to separate them). | [optional] |
| **private_nic_mac_address** | **string**| List Instances associated with the given private NIC MAC address. | [optional] |
| **servers** | **string**| List Instances from these server ids (use commas to separate them). | [optional] |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1ListServersResponse**](../Model/ScalewayInstanceV1ListServersResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `serverAction()`
```php
serverAction($zone, $server_id, $server_action_request): \OpenAPI\Client\Model\ScalewayInstanceV1ServerActionResponse
```
Perform action
Perform an action on an Instance. Available actions are: * `poweron`: Start a stopped Instance. * `poweroff`: Fully stop the Instance and release the hypervisor slot. * `stop_in_place`: Stop the Instance, but keep the slot on the hypervisor. * `reboot`: Stop the instance and restart it. * `backup`: Create an image with all the volumes of an Instance. * `terminate`: Delete the Instance along with its attached volumes, except for SBS volumes. * `enable_routed_ip`: Migrate the Instance to the new network stack. The `terminate` action will result in the deletion of `l_ssd`, `b_ssd` and `scratch` volumes types, `sbs_volume` volumes type will only be detached. If you want to preserve your volumes, you should detach them before the Instance deletion or `terminate` action. The `backup` action can be done with: * No `volumes` key in the body: an image is created with snapshots of all the server volumes, except for the `scratch` volumes types. * `volumes` key in the body with a dictionary as value, in this dictionary volumes UUID as keys and empty dictionaries as values : an image is created with the snapshots of the volumes in `volumes` key. `scratch` volumes types can't be shapshotted.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\InstancesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$server_id = 'server_id_example'; // string | UUID of the Instance.
$server_action_request = new \OpenAPI\Client\Model\ServerActionRequest(); // \OpenAPI\Client\Model\ServerActionRequest
try {
$result = $apiInstance->serverAction($zone, $server_id, $server_action_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling InstancesApi->serverAction: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **server_id** | **string**| UUID of the Instance. | |
| **server_action_request** | [**\OpenAPI\Client\Model\ServerActionRequest**](../Model/ServerActionRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1ServerActionResponse**](../Model/ScalewayInstanceV1ServerActionResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `updateServer()`
```php
updateServer($zone, $server_id, $update_server_request): \OpenAPI\Client\Model\ScalewayInstanceV1UpdateServerResponse
```
Update an Instance
Update the Instance information, such as name, boot mode, or tags.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\InstancesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$server_id = 'server_id_example'; // string | UUID of the Instance.
$update_server_request = new \OpenAPI\Client\Model\UpdateServerRequest(); // \OpenAPI\Client\Model\UpdateServerRequest
try {
$result = $apiInstance->updateServer($zone, $server_id, $update_server_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling InstancesApi->updateServer: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **server_id** | **string**| UUID of the Instance. | |
| **update_server_request** | [**\OpenAPI\Client\Model\UpdateServerRequest**](../Model/UpdateServerRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1UpdateServerResponse**](../Model/ScalewayInstanceV1UpdateServerResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

View file

@ -0,0 +1,607 @@
# OpenAPI\Client\PlacementGroupsApi
All URIs are relative to https://api.scaleway.com, except if the operation defines another base path.
| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**createPlacementGroup()**](PlacementGroupsApi.md#createPlacementGroup) | **POST** /instance/v1/zones/{zone}/placement_groups | Create a placement group |
| [**deletePlacementGroup()**](PlacementGroupsApi.md#deletePlacementGroup) | **DELETE** /instance/v1/zones/{zone}/placement_groups/{placement_group_id} | Delete the specified placement group |
| [**getPlacementGroup()**](PlacementGroupsApi.md#getPlacementGroup) | **GET** /instance/v1/zones/{zone}/placement_groups/{placement_group_id} | Get a placement group |
| [**getPlacementGroupServers()**](PlacementGroupsApi.md#getPlacementGroupServers) | **GET** /instance/v1/zones/{zone}/placement_groups/{placement_group_id}/servers | Get placement group servers |
| [**listPlacementGroups()**](PlacementGroupsApi.md#listPlacementGroups) | **GET** /instance/v1/zones/{zone}/placement_groups | List placement groups |
| [**setPlacementGroup()**](PlacementGroupsApi.md#setPlacementGroup) | **PUT** /instance/v1/zones/{zone}/placement_groups/{placement_group_id} | Set placement group |
| [**setPlacementGroupServers()**](PlacementGroupsApi.md#setPlacementGroupServers) | **PUT** /instance/v1/zones/{zone}/placement_groups/{placement_group_id}/servers | Set placement group servers |
| [**updatePlacementGroup()**](PlacementGroupsApi.md#updatePlacementGroup) | **PATCH** /instance/v1/zones/{zone}/placement_groups/{placement_group_id} | Update a placement group |
| [**updatePlacementGroupServers()**](PlacementGroupsApi.md#updatePlacementGroupServers) | **PATCH** /instance/v1/zones/{zone}/placement_groups/{placement_group_id}/servers | Update placement group servers |
## `createPlacementGroup()`
```php
createPlacementGroup($zone, $create_placement_group_request): \OpenAPI\Client\Model\ScalewayInstanceV1CreatePlacementGroupResponse
```
Create a placement group
Create a new placement group in a specified Availability Zone.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\PlacementGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$create_placement_group_request = new \OpenAPI\Client\Model\CreatePlacementGroupRequest(); // \OpenAPI\Client\Model\CreatePlacementGroupRequest
try {
$result = $apiInstance->createPlacementGroup($zone, $create_placement_group_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PlacementGroupsApi->createPlacementGroup: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **create_placement_group_request** | [**\OpenAPI\Client\Model\CreatePlacementGroupRequest**](../Model/CreatePlacementGroupRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1CreatePlacementGroupResponse**](../Model/ScalewayInstanceV1CreatePlacementGroupResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `deletePlacementGroup()`
```php
deletePlacementGroup($zone, $placement_group_id)
```
Delete the specified placement group
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\PlacementGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$placement_group_id = 'placement_group_id_example'; // string | UUID of the placement group you want to delete.
try {
$apiInstance->deletePlacementGroup($zone, $placement_group_id);
} catch (Exception $e) {
echo 'Exception when calling PlacementGroupsApi->deletePlacementGroup: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **placement_group_id** | **string**| UUID of the placement group you want to delete. | |
### Return type
void (empty response body)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `getPlacementGroup()`
```php
getPlacementGroup($zone, $placement_group_id): \OpenAPI\Client\Model\ScalewayInstanceV1GetPlacementGroupResponse
```
Get a placement group
Get the specified placement group.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\PlacementGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$placement_group_id = 'placement_group_id_example'; // string | UUID of the placement group you want to get.
try {
$result = $apiInstance->getPlacementGroup($zone, $placement_group_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PlacementGroupsApi->getPlacementGroup: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **placement_group_id** | **string**| UUID of the placement group you want to get. | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1GetPlacementGroupResponse**](../Model/ScalewayInstanceV1GetPlacementGroupResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `getPlacementGroupServers()`
```php
getPlacementGroupServers($zone, $placement_group_id): \OpenAPI\Client\Model\ScalewayInstanceV1GetPlacementGroupServersResponse
```
Get placement group servers
Get all Instances belonging to the specified placement group.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\PlacementGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$placement_group_id = 'placement_group_id_example'; // string | UUID of the placement group you want to get.
try {
$result = $apiInstance->getPlacementGroupServers($zone, $placement_group_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PlacementGroupsApi->getPlacementGroupServers: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **placement_group_id** | **string**| UUID of the placement group you want to get. | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1GetPlacementGroupServersResponse**](../Model/ScalewayInstanceV1GetPlacementGroupServersResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `listPlacementGroups()`
```php
listPlacementGroups($zone, $per_page, $page, $organization, $project, $tags, $name): \OpenAPI\Client\Model\ScalewayInstanceV1ListPlacementGroupsResponse
```
List placement groups
List all placement groups in a specified Availability Zone.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\PlacementGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$per_page = 56; // int | A positive integer lower or equal to 100 to select the number of items to return.
$page = 56; // int | A positive integer to choose the page to return.
$organization = 'organization_example'; // string | List only placement groups of this Organization ID.
$project = 'project_example'; // string | List only placement groups of this Project ID.
$tags = 'tags_example'; // string | List placement groups with these exact tags (to filter with several tags, use commas to separate them).
$name = 'name_example'; // string | Filter placement groups by name (for eg. \"cluster1\" will return \"cluster100\" and \"cluster1\" but not \"foo\").
try {
$result = $apiInstance->listPlacementGroups($zone, $per_page, $page, $organization, $project, $tags, $name);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PlacementGroupsApi->listPlacementGroups: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **per_page** | **int**| A positive integer lower or equal to 100 to select the number of items to return. | [optional] |
| **page** | **int**| A positive integer to choose the page to return. | [optional] |
| **organization** | **string**| List only placement groups of this Organization ID. | [optional] |
| **project** | **string**| List only placement groups of this Project ID. | [optional] |
| **tags** | **string**| List placement groups with these exact tags (to filter with several tags, use commas to separate them). | [optional] |
| **name** | **string**| Filter placement groups by name (for eg. \&quot;cluster1\&quot; will return \&quot;cluster100\&quot; and \&quot;cluster1\&quot; but not \&quot;foo\&quot;). | [optional] |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1ListPlacementGroupsResponse**](../Model/ScalewayInstanceV1ListPlacementGroupsResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `setPlacementGroup()`
```php
setPlacementGroup($zone, $placement_group_id, $set_placement_group_request): \OpenAPI\Client\Model\ScalewayInstanceV1SetPlacementGroupResponse
```
Set placement group
Set all parameters of the specified placement group.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\PlacementGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$placement_group_id = 'placement_group_id_example'; // string
$set_placement_group_request = new \OpenAPI\Client\Model\SetPlacementGroupRequest(); // \OpenAPI\Client\Model\SetPlacementGroupRequest
try {
$result = $apiInstance->setPlacementGroup($zone, $placement_group_id, $set_placement_group_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PlacementGroupsApi->setPlacementGroup: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **placement_group_id** | **string**| | |
| **set_placement_group_request** | [**\OpenAPI\Client\Model\SetPlacementGroupRequest**](../Model/SetPlacementGroupRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1SetPlacementGroupResponse**](../Model/ScalewayInstanceV1SetPlacementGroupResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `setPlacementGroupServers()`
```php
setPlacementGroupServers($zone, $placement_group_id, $set_placement_group_servers_request): \OpenAPI\Client\Model\ScalewayInstanceV1SetPlacementGroupServersResponse
```
Set placement group servers
Set all Instances belonging to the specified placement group.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\PlacementGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$placement_group_id = 'placement_group_id_example'; // string | UUID of the placement group you want to set.
$set_placement_group_servers_request = new \OpenAPI\Client\Model\SetPlacementGroupServersRequest(); // \OpenAPI\Client\Model\SetPlacementGroupServersRequest
try {
$result = $apiInstance->setPlacementGroupServers($zone, $placement_group_id, $set_placement_group_servers_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PlacementGroupsApi->setPlacementGroupServers: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **placement_group_id** | **string**| UUID of the placement group you want to set. | |
| **set_placement_group_servers_request** | [**\OpenAPI\Client\Model\SetPlacementGroupServersRequest**](../Model/SetPlacementGroupServersRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1SetPlacementGroupServersResponse**](../Model/ScalewayInstanceV1SetPlacementGroupServersResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `updatePlacementGroup()`
```php
updatePlacementGroup($zone, $placement_group_id, $update_placement_group_request): \OpenAPI\Client\Model\ScalewayInstanceV1UpdatePlacementGroupResponse
```
Update a placement group
Update one or more parameter of the specified placement group.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\PlacementGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$placement_group_id = 'placement_group_id_example'; // string | UUID of the placement group.
$update_placement_group_request = new \OpenAPI\Client\Model\UpdatePlacementGroupRequest(); // \OpenAPI\Client\Model\UpdatePlacementGroupRequest
try {
$result = $apiInstance->updatePlacementGroup($zone, $placement_group_id, $update_placement_group_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PlacementGroupsApi->updatePlacementGroup: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **placement_group_id** | **string**| UUID of the placement group. | |
| **update_placement_group_request** | [**\OpenAPI\Client\Model\UpdatePlacementGroupRequest**](../Model/UpdatePlacementGroupRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1UpdatePlacementGroupResponse**](../Model/ScalewayInstanceV1UpdatePlacementGroupResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `updatePlacementGroupServers()`
```php
updatePlacementGroupServers($zone, $placement_group_id, $set_placement_group_servers_request): \OpenAPI\Client\Model\ScalewayInstanceV1UpdatePlacementGroupServersResponse
```
Update placement group servers
Update all Instances belonging to the specified placement group.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\PlacementGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$placement_group_id = 'placement_group_id_example'; // string | UUID of the placement group you want to update.
$set_placement_group_servers_request = new \OpenAPI\Client\Model\SetPlacementGroupServersRequest(); // \OpenAPI\Client\Model\SetPlacementGroupServersRequest
try {
$result = $apiInstance->updatePlacementGroupServers($zone, $placement_group_id, $set_placement_group_servers_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PlacementGroupsApi->updatePlacementGroupServers: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **placement_group_id** | **string**| UUID of the placement group you want to update. | |
| **set_placement_group_servers_request** | [**\OpenAPI\Client\Model\SetPlacementGroupServersRequest**](../Model/SetPlacementGroupServersRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1UpdatePlacementGroupServersResponse**](../Model/ScalewayInstanceV1UpdatePlacementGroupServersResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

343
docs/Api/PrivateNICsApi.md Normal file
View file

@ -0,0 +1,343 @@
# OpenAPI\Client\PrivateNICsApi
All URIs are relative to https://api.scaleway.com, except if the operation defines another base path.
| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**createPrivateNIC()**](PrivateNICsApi.md#createPrivateNIC) | **POST** /instance/v1/zones/{zone}/servers/{server_id}/private_nics | Create a private NIC connecting an Instance to a Private Network |
| [**deletePrivateNIC()**](PrivateNICsApi.md#deletePrivateNIC) | **DELETE** /instance/v1/zones/{zone}/servers/{server_id}/private_nics/{private_nic_id} | Delete a private NIC |
| [**getPrivateNIC()**](PrivateNICsApi.md#getPrivateNIC) | **GET** /instance/v1/zones/{zone}/servers/{server_id}/private_nics/{private_nic_id} | Get a private NIC |
| [**listPrivateNICs()**](PrivateNICsApi.md#listPrivateNICs) | **GET** /instance/v1/zones/{zone}/servers/{server_id}/private_nics | List all private NICs |
| [**updatePrivateNIC()**](PrivateNICsApi.md#updatePrivateNIC) | **PATCH** /instance/v1/zones/{zone}/servers/{server_id}/private_nics/{private_nic_id} | Update a private NIC |
## `createPrivateNIC()`
```php
createPrivateNIC($zone, $server_id, $create_private_nic_request): \OpenAPI\Client\Model\ScalewayInstanceV1CreatePrivateNICResponse
```
Create a private NIC connecting an Instance to a Private Network
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\PrivateNICsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$server_id = 'server_id_example'; // string | UUID of the Instance the private NIC will be attached to.
$create_private_nic_request = new \OpenAPI\Client\Model\CreatePrivateNICRequest(); // \OpenAPI\Client\Model\CreatePrivateNICRequest
try {
$result = $apiInstance->createPrivateNIC($zone, $server_id, $create_private_nic_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PrivateNICsApi->createPrivateNIC: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **server_id** | **string**| UUID of the Instance the private NIC will be attached to. | |
| **create_private_nic_request** | [**\OpenAPI\Client\Model\CreatePrivateNICRequest**](../Model/CreatePrivateNICRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1CreatePrivateNICResponse**](../Model/ScalewayInstanceV1CreatePrivateNICResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `deletePrivateNIC()`
```php
deletePrivateNIC($zone, $server_id, $private_nic_id)
```
Delete a private NIC
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\PrivateNICsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$server_id = 'server_id_example'; // string | Instance to which the private NIC is attached.
$private_nic_id = 'private_nic_id_example'; // string | Private NIC unique ID.
try {
$apiInstance->deletePrivateNIC($zone, $server_id, $private_nic_id);
} catch (Exception $e) {
echo 'Exception when calling PrivateNICsApi->deletePrivateNIC: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **server_id** | **string**| Instance to which the private NIC is attached. | |
| **private_nic_id** | **string**| Private NIC unique ID. | |
### Return type
void (empty response body)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `getPrivateNIC()`
```php
getPrivateNIC($zone, $server_id, $private_nic_id): \OpenAPI\Client\Model\ScalewayInstanceV1GetPrivateNICResponse
```
Get a private NIC
Get private NIC properties.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\PrivateNICsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$server_id = 'server_id_example'; // string | Instance to which the private NIC is attached.
$private_nic_id = 'private_nic_id_example'; // string | Private NIC unique ID.
try {
$result = $apiInstance->getPrivateNIC($zone, $server_id, $private_nic_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PrivateNICsApi->getPrivateNIC: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **server_id** | **string**| Instance to which the private NIC is attached. | |
| **private_nic_id** | **string**| Private NIC unique ID. | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1GetPrivateNICResponse**](../Model/ScalewayInstanceV1GetPrivateNICResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `listPrivateNICs()`
```php
listPrivateNICs($zone, $server_id, $tags, $per_page, $page): \OpenAPI\Client\Model\ScalewayInstanceV1ListPrivateNICsResponse
```
List all private NICs
List all private NICs of a specified Instance.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\PrivateNICsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$server_id = 'server_id_example'; // string | Instance to which the private NIC is attached.
$tags = 'tags_example'; // string | Private NIC tags.
$per_page = 56; // int | A positive integer lower or equal to 100 to select the number of items to return.
$page = 56; // int | A positive integer to choose the page to return.
try {
$result = $apiInstance->listPrivateNICs($zone, $server_id, $tags, $per_page, $page);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PrivateNICsApi->listPrivateNICs: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **server_id** | **string**| Instance to which the private NIC is attached. | |
| **tags** | **string**| Private NIC tags. | [optional] |
| **per_page** | **int**| A positive integer lower or equal to 100 to select the number of items to return. | [optional] |
| **page** | **int**| A positive integer to choose the page to return. | [optional] |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1ListPrivateNICsResponse**](../Model/ScalewayInstanceV1ListPrivateNICsResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `updatePrivateNIC()`
```php
updatePrivateNIC($zone, $server_id, $private_nic_id, $update_private_nic_request): \OpenAPI\Client\Model\ScalewayInstanceV1PrivateNIC
```
Update a private NIC
Update one or more parameter(s) of a specified private NIC.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\PrivateNICsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$server_id = 'server_id_example'; // string | UUID of the Instance the private NIC will be attached to.
$private_nic_id = 'private_nic_id_example'; // string | Private NIC unique ID.
$update_private_nic_request = new \OpenAPI\Client\Model\UpdatePrivateNICRequest(); // \OpenAPI\Client\Model\UpdatePrivateNICRequest
try {
$result = $apiInstance->updatePrivateNIC($zone, $server_id, $private_nic_id, $update_private_nic_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PrivateNICsApi->updatePrivateNIC: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **server_id** | **string**| UUID of the Instance the private NIC will be attached to. | |
| **private_nic_id** | **string**| Private NIC unique ID. | |
| **update_private_nic_request** | [**\OpenAPI\Client\Model\UpdatePrivateNICRequest**](../Model/UpdatePrivateNICRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1PrivateNIC**](../Model/ScalewayInstanceV1PrivateNIC.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

View file

@ -0,0 +1,949 @@
# OpenAPI\Client\SecurityGroupsApi
All URIs are relative to https://api.scaleway.com, except if the operation defines another base path.
| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**createSecurityGroup()**](SecurityGroupsApi.md#createSecurityGroup) | **POST** /instance/v1/zones/{zone}/security_groups | Create a security group |
| [**createSecurityGroupRule()**](SecurityGroupsApi.md#createSecurityGroupRule) | **POST** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules | Create rule |
| [**deleteSecurityGroup()**](SecurityGroupsApi.md#deleteSecurityGroup) | **DELETE** /instance/v1/zones/{zone}/security_groups/{security_group_id} | Delete a security group |
| [**deleteSecurityGroupRule()**](SecurityGroupsApi.md#deleteSecurityGroupRule) | **DELETE** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules/{security_group_rule_id} | Delete rule |
| [**getSecurityGroup()**](SecurityGroupsApi.md#getSecurityGroup) | **GET** /instance/v1/zones/{zone}/security_groups/{security_group_id} | Get a security group |
| [**getSecurityGroupRule()**](SecurityGroupsApi.md#getSecurityGroupRule) | **GET** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules/{security_group_rule_id} | Get rule |
| [**listDefaultSecurityGroupRules()**](SecurityGroupsApi.md#listDefaultSecurityGroupRules) | **GET** /instance/v1/zones/{zone}/security_groups/default/rules | Get default rules |
| [**listSecurityGroupRules()**](SecurityGroupsApi.md#listSecurityGroupRules) | **GET** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules | List rules |
| [**listSecurityGroups()**](SecurityGroupsApi.md#listSecurityGroups) | **GET** /instance/v1/zones/{zone}/security_groups | List security groups |
| [**setSecurityGroup()**](SecurityGroupsApi.md#setSecurityGroup) | **PUT** /instance/v1/zones/{zone}/security_groups/{id} | Update a security group |
| [**setSecurityGroupRule()**](SecurityGroupsApi.md#setSecurityGroupRule) | **PUT** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules/{security_group_rule_id} | Set security group rule |
| [**setSecurityGroupRules()**](SecurityGroupsApi.md#setSecurityGroupRules) | **PUT** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules | Update all the rules of a security group |
| [**updateSecurityGroup()**](SecurityGroupsApi.md#updateSecurityGroup) | **PATCH** /instance/v1/zones/{zone}/security_groups/{security_group_id} | Update a security group |
| [**updateSecurityGroupRule()**](SecurityGroupsApi.md#updateSecurityGroupRule) | **PATCH** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules/{security_group_rule_id} | Update security group rule |
## `createSecurityGroup()`
```php
createSecurityGroup($zone, $create_security_group_request): \OpenAPI\Client\Model\ScalewayInstanceV1CreateSecurityGroupResponse
```
Create a security group
Create a security group with a specified name and description.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SecurityGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$create_security_group_request = new \OpenAPI\Client\Model\CreateSecurityGroupRequest(); // \OpenAPI\Client\Model\CreateSecurityGroupRequest
try {
$result = $apiInstance->createSecurityGroup($zone, $create_security_group_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SecurityGroupsApi->createSecurityGroup: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **create_security_group_request** | [**\OpenAPI\Client\Model\CreateSecurityGroupRequest**](../Model/CreateSecurityGroupRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1CreateSecurityGroupResponse**](../Model/ScalewayInstanceV1CreateSecurityGroupResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `createSecurityGroupRule()`
```php
createSecurityGroupRule($zone, $security_group_id, $create_security_group_rule_request): \OpenAPI\Client\Model\ScalewayInstanceV1CreateSecurityGroupRuleResponse
```
Create rule
Create a rule in the specified security group ID.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SecurityGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$security_group_id = 'security_group_id_example'; // string | UUID of the security group.
$create_security_group_rule_request = new \OpenAPI\Client\Model\CreateSecurityGroupRuleRequest(); // \OpenAPI\Client\Model\CreateSecurityGroupRuleRequest
try {
$result = $apiInstance->createSecurityGroupRule($zone, $security_group_id, $create_security_group_rule_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SecurityGroupsApi->createSecurityGroupRule: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **security_group_id** | **string**| UUID of the security group. | |
| **create_security_group_rule_request** | [**\OpenAPI\Client\Model\CreateSecurityGroupRuleRequest**](../Model/CreateSecurityGroupRuleRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1CreateSecurityGroupRuleResponse**](../Model/ScalewayInstanceV1CreateSecurityGroupRuleResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `deleteSecurityGroup()`
```php
deleteSecurityGroup($zone, $security_group_id)
```
Delete a security group
Delete a security group with the specified ID.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SecurityGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$security_group_id = 'security_group_id_example'; // string | UUID of the security group you want to delete.
try {
$apiInstance->deleteSecurityGroup($zone, $security_group_id);
} catch (Exception $e) {
echo 'Exception when calling SecurityGroupsApi->deleteSecurityGroup: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **security_group_id** | **string**| UUID of the security group you want to delete. | |
### Return type
void (empty response body)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `deleteSecurityGroupRule()`
```php
deleteSecurityGroupRule($zone, $security_group_id, $security_group_rule_id)
```
Delete rule
Delete a security group rule with the specified ID.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SecurityGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$security_group_id = 'security_group_id_example'; // string
$security_group_rule_id = 'security_group_rule_id_example'; // string
try {
$apiInstance->deleteSecurityGroupRule($zone, $security_group_id, $security_group_rule_id);
} catch (Exception $e) {
echo 'Exception when calling SecurityGroupsApi->deleteSecurityGroupRule: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **security_group_id** | **string**| | |
| **security_group_rule_id** | **string**| | |
### Return type
void (empty response body)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `getSecurityGroup()`
```php
getSecurityGroup($zone, $security_group_id): \OpenAPI\Client\Model\ScalewayInstanceV1GetSecurityGroupResponse
```
Get a security group
Get the details of a security group with the specified ID.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SecurityGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$security_group_id = 'security_group_id_example'; // string | UUID of the security group you want to get.
try {
$result = $apiInstance->getSecurityGroup($zone, $security_group_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SecurityGroupsApi->getSecurityGroup: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **security_group_id** | **string**| UUID of the security group you want to get. | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1GetSecurityGroupResponse**](../Model/ScalewayInstanceV1GetSecurityGroupResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `getSecurityGroupRule()`
```php
getSecurityGroupRule($zone, $security_group_id, $security_group_rule_id): \OpenAPI\Client\Model\ScalewayInstanceV1GetSecurityGroupRuleResponse
```
Get rule
Get details of a security group rule with the specified ID.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SecurityGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$security_group_id = 'security_group_id_example'; // string
$security_group_rule_id = 'security_group_rule_id_example'; // string
try {
$result = $apiInstance->getSecurityGroupRule($zone, $security_group_id, $security_group_rule_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SecurityGroupsApi->getSecurityGroupRule: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **security_group_id** | **string**| | |
| **security_group_rule_id** | **string**| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1GetSecurityGroupRuleResponse**](../Model/ScalewayInstanceV1GetSecurityGroupRuleResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `listDefaultSecurityGroupRules()`
```php
listDefaultSecurityGroupRules($zone): \OpenAPI\Client\Model\ScalewayInstanceV1ListSecurityGroupRulesResponse
```
Get default rules
Lists the default rules applied to all the security groups.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SecurityGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
try {
$result = $apiInstance->listDefaultSecurityGroupRules($zone);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SecurityGroupsApi->listDefaultSecurityGroupRules: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1ListSecurityGroupRulesResponse**](../Model/ScalewayInstanceV1ListSecurityGroupRulesResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `listSecurityGroupRules()`
```php
listSecurityGroupRules($zone, $security_group_id, $per_page, $page): \OpenAPI\Client\Model\ScalewayInstanceV1ListSecurityGroupRulesResponse
```
List rules
List the rules of the a specified security group ID.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SecurityGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$security_group_id = 'security_group_id_example'; // string | UUID of the security group.
$per_page = 56; // int | A positive integer lower or equal to 100 to select the number of items to return.
$page = 56; // int | A positive integer to choose the page to return.
try {
$result = $apiInstance->listSecurityGroupRules($zone, $security_group_id, $per_page, $page);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SecurityGroupsApi->listSecurityGroupRules: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **security_group_id** | **string**| UUID of the security group. | |
| **per_page** | **int**| A positive integer lower or equal to 100 to select the number of items to return. | [optional] |
| **page** | **int**| A positive integer to choose the page to return. | [optional] |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1ListSecurityGroupRulesResponse**](../Model/ScalewayInstanceV1ListSecurityGroupRulesResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `listSecurityGroups()`
```php
listSecurityGroups($zone, $name, $organization, $project, $tags, $project_default, $per_page, $page): \OpenAPI\Client\Model\ScalewayInstanceV1ListSecurityGroupsResponse
```
List security groups
List all existing security groups.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SecurityGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$name = 'name_example'; // string | Name of the security group.
$organization = 'organization_example'; // string | Security group Organization ID.
$project = 'project_example'; // string | Security group Project ID.
$tags = 'tags_example'; // string | List security groups with these exact tags (to filter with several tags, use commas to separate them).
$project_default = True; // bool | Filter security groups with this value for project_default.
$per_page = 56; // int | A positive integer lower or equal to 100 to select the number of items to return.
$page = 56; // int | A positive integer to choose the page to return.
try {
$result = $apiInstance->listSecurityGroups($zone, $name, $organization, $project, $tags, $project_default, $per_page, $page);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SecurityGroupsApi->listSecurityGroups: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **name** | **string**| Name of the security group. | [optional] |
| **organization** | **string**| Security group Organization ID. | [optional] |
| **project** | **string**| Security group Project ID. | [optional] |
| **tags** | **string**| List security groups with these exact tags (to filter with several tags, use commas to separate them). | [optional] |
| **project_default** | **bool**| Filter security groups with this value for project_default. | [optional] |
| **per_page** | **int**| A positive integer lower or equal to 100 to select the number of items to return. | [optional] |
| **page** | **int**| A positive integer to choose the page to return. | [optional] |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1ListSecurityGroupsResponse**](../Model/ScalewayInstanceV1ListSecurityGroupsResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `setSecurityGroup()`
```php
setSecurityGroup($zone, $id, $set_security_group_request): \OpenAPI\Client\Model\ScalewayInstanceV1SetSecurityGroupResponse
```
Update a security group
Replace all security group properties with a security group message.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SecurityGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$id = 'id_example'; // string | UUID of the security group.
$set_security_group_request = new \OpenAPI\Client\Model\SetSecurityGroupRequest(); // \OpenAPI\Client\Model\SetSecurityGroupRequest
try {
$result = $apiInstance->setSecurityGroup($zone, $id, $set_security_group_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SecurityGroupsApi->setSecurityGroup: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **id** | **string**| UUID of the security group. | |
| **set_security_group_request** | [**\OpenAPI\Client\Model\SetSecurityGroupRequest**](../Model/SetSecurityGroupRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1SetSecurityGroupResponse**](../Model/ScalewayInstanceV1SetSecurityGroupResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `setSecurityGroupRule()`
```php
setSecurityGroupRule($zone, $security_group_id, $security_group_rule_id, $set_security_group_rule_request): \OpenAPI\Client\Model\ScalewayInstanceV1SetSecurityGroupRuleResponse
```
Set security group rule
Replace all the properties of a rule from a specified security group.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SecurityGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$security_group_id = 'security_group_id_example'; // string
$security_group_rule_id = 'security_group_rule_id_example'; // string
$set_security_group_rule_request = new \OpenAPI\Client\Model\SetSecurityGroupRuleRequest(); // \OpenAPI\Client\Model\SetSecurityGroupRuleRequest
try {
$result = $apiInstance->setSecurityGroupRule($zone, $security_group_id, $security_group_rule_id, $set_security_group_rule_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SecurityGroupsApi->setSecurityGroupRule: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **security_group_id** | **string**| | |
| **security_group_rule_id** | **string**| | |
| **set_security_group_rule_request** | [**\OpenAPI\Client\Model\SetSecurityGroupRuleRequest**](../Model/SetSecurityGroupRuleRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1SetSecurityGroupRuleResponse**](../Model/ScalewayInstanceV1SetSecurityGroupRuleResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `setSecurityGroupRules()`
```php
setSecurityGroupRules($zone, $security_group_id, $set_security_group_rules_request): \OpenAPI\Client\Model\ScalewayInstanceV1SetSecurityGroupRulesResponse
```
Update all the rules of a security group
Replaces the existing rules of the security group with the rules provided. This endpoint supports the update of existing rules, creation of new rules and deletion of existing rules when they are not passed in the request.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SecurityGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$security_group_id = 'security_group_id_example'; // string | UUID of the security group to update the rules on.
$set_security_group_rules_request = new \OpenAPI\Client\Model\SetSecurityGroupRulesRequest(); // \OpenAPI\Client\Model\SetSecurityGroupRulesRequest
try {
$result = $apiInstance->setSecurityGroupRules($zone, $security_group_id, $set_security_group_rules_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SecurityGroupsApi->setSecurityGroupRules: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **security_group_id** | **string**| UUID of the security group to update the rules on. | |
| **set_security_group_rules_request** | [**\OpenAPI\Client\Model\SetSecurityGroupRulesRequest**](../Model/SetSecurityGroupRulesRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1SetSecurityGroupRulesResponse**](../Model/ScalewayInstanceV1SetSecurityGroupRulesResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `updateSecurityGroup()`
```php
updateSecurityGroup($zone, $security_group_id, $update_security_group_request): \OpenAPI\Client\Model\ScalewayInstanceV1UpdateSecurityGroupResponse
```
Update a security group
Update the properties of security group.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SecurityGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$security_group_id = 6170692e-7363-616c-6577-61792e636f6d; // string | UUID of the security group. (UUID format)
$update_security_group_request = new \OpenAPI\Client\Model\UpdateSecurityGroupRequest(); // \OpenAPI\Client\Model\UpdateSecurityGroupRequest
try {
$result = $apiInstance->updateSecurityGroup($zone, $security_group_id, $update_security_group_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SecurityGroupsApi->updateSecurityGroup: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **security_group_id** | **string**| UUID of the security group. (UUID format) | |
| **update_security_group_request** | [**\OpenAPI\Client\Model\UpdateSecurityGroupRequest**](../Model/UpdateSecurityGroupRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1UpdateSecurityGroupResponse**](../Model/ScalewayInstanceV1UpdateSecurityGroupResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `updateSecurityGroupRule()`
```php
updateSecurityGroupRule($zone, $security_group_id, $security_group_rule_id, $update_security_group_rule_request): \OpenAPI\Client\Model\ScalewayInstanceV1UpdateSecurityGroupRuleResponse
```
Update security group rule
Update the properties of a rule from a specified security group.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SecurityGroupsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$security_group_id = 6170692e-7363-616c-6577-61792e636f6d; // string | UUID of the security group. (UUID format)
$security_group_rule_id = 6170692e-7363-616c-6577-61792e636f6d; // string | UUID of the rule. (UUID format)
$update_security_group_rule_request = new \OpenAPI\Client\Model\UpdateSecurityGroupRuleRequest(); // \OpenAPI\Client\Model\UpdateSecurityGroupRuleRequest
try {
$result = $apiInstance->updateSecurityGroupRule($zone, $security_group_id, $security_group_rule_id, $update_security_group_rule_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SecurityGroupsApi->updateSecurityGroupRule: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **security_group_id** | **string**| UUID of the security group. (UUID format) | |
| **security_group_rule_id** | **string**| UUID of the rule. (UUID format) | |
| **update_security_group_rule_request** | [**\OpenAPI\Client\Model\UpdateSecurityGroupRuleRequest**](../Model/UpdateSecurityGroupRuleRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1UpdateSecurityGroupRuleResponse**](../Model/ScalewayInstanceV1UpdateSecurityGroupRuleResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

479
docs/Api/SnapshotsApi.md Normal file
View file

@ -0,0 +1,479 @@
# OpenAPI\Client\SnapshotsApi
All URIs are relative to https://api.scaleway.com, except if the operation defines another base path.
| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**createSnapshot()**](SnapshotsApi.md#createSnapshot) | **POST** /instance/v1/zones/{zone}/snapshots | Create a snapshot from a specified volume or from a QCOW2 file |
| [**deleteSnapshot()**](SnapshotsApi.md#deleteSnapshot) | **DELETE** /instance/v1/zones/{zone}/snapshots/{snapshot_id} | Delete a snapshot |
| [**exportSnapshot()**](SnapshotsApi.md#exportSnapshot) | **POST** /instance/v1/zones/{zone}/snapshots/{snapshot_id}/export | Export a snapshot |
| [**getSnapshot()**](SnapshotsApi.md#getSnapshot) | **GET** /instance/v1/zones/{zone}/snapshots/{snapshot_id} | Get a snapshot |
| [**listSnapshots()**](SnapshotsApi.md#listSnapshots) | **GET** /instance/v1/zones/{zone}/snapshots | List snapshots |
| [**setSnapshot()**](SnapshotsApi.md#setSnapshot) | **PUT** /instance/v1/zones/{zone}/snapshots/{snapshot_id} | Set snapshot |
| [**updateSnapshot()**](SnapshotsApi.md#updateSnapshot) | **PATCH** /instance/v1/zones/{zone}/snapshots/{snapshot_id} | Update a snapshot |
## `createSnapshot()`
```php
createSnapshot($zone, $create_snapshot_request): \OpenAPI\Client\Model\ScalewayInstanceV1CreateSnapshotResponse
```
Create a snapshot from a specified volume or from a QCOW2 file
Create a snapshot from a specified volume or from a QCOW2 file in a specified Availability Zone.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SnapshotsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$create_snapshot_request = new \OpenAPI\Client\Model\CreateSnapshotRequest(); // \OpenAPI\Client\Model\CreateSnapshotRequest
try {
$result = $apiInstance->createSnapshot($zone, $create_snapshot_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SnapshotsApi->createSnapshot: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **create_snapshot_request** | [**\OpenAPI\Client\Model\CreateSnapshotRequest**](../Model/CreateSnapshotRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1CreateSnapshotResponse**](../Model/ScalewayInstanceV1CreateSnapshotResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `deleteSnapshot()`
```php
deleteSnapshot($zone, $snapshot_id)
```
Delete a snapshot
Delete the snapshot with the specified ID.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SnapshotsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$snapshot_id = 'snapshot_id_example'; // string | UUID of the snapshot you want to delete.
try {
$apiInstance->deleteSnapshot($zone, $snapshot_id);
} catch (Exception $e) {
echo 'Exception when calling SnapshotsApi->deleteSnapshot: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **snapshot_id** | **string**| UUID of the snapshot you want to delete. | |
### Return type
void (empty response body)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `exportSnapshot()`
```php
exportSnapshot($zone, $snapshot_id, $export_snapshot_request): \OpenAPI\Client\Model\ScalewayInstanceV1ExportSnapshotResponse
```
Export a snapshot
Export a snapshot to a specified Object Storage bucket in the same region.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SnapshotsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$snapshot_id = 'snapshot_id_example'; // string | Snapshot ID.
$export_snapshot_request = new \OpenAPI\Client\Model\ExportSnapshotRequest(); // \OpenAPI\Client\Model\ExportSnapshotRequest
try {
$result = $apiInstance->exportSnapshot($zone, $snapshot_id, $export_snapshot_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SnapshotsApi->exportSnapshot: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **snapshot_id** | **string**| Snapshot ID. | |
| **export_snapshot_request** | [**\OpenAPI\Client\Model\ExportSnapshotRequest**](../Model/ExportSnapshotRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1ExportSnapshotResponse**](../Model/ScalewayInstanceV1ExportSnapshotResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `getSnapshot()`
```php
getSnapshot($zone, $snapshot_id): \OpenAPI\Client\Model\ScalewayInstanceV1GetSnapshotResponse
```
Get a snapshot
Get details of a snapshot with the specified ID.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SnapshotsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$snapshot_id = 'snapshot_id_example'; // string | UUID of the snapshot you want to get.
try {
$result = $apiInstance->getSnapshot($zone, $snapshot_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SnapshotsApi->getSnapshot: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **snapshot_id** | **string**| UUID of the snapshot you want to get. | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1GetSnapshotResponse**](../Model/ScalewayInstanceV1GetSnapshotResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `listSnapshots()`
```php
listSnapshots($zone, $organization, $project, $per_page, $page, $name, $tags, $base_volume_id): \OpenAPI\Client\Model\ScalewayInstanceV1ListSnapshotsResponse
```
List snapshots
List all snapshots of an Organization in a specified Availability Zone.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SnapshotsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$organization = 'organization_example'; // string | List snapshots only for this Organization ID.
$project = 'project_example'; // string | List snapshots only for this Project ID.
$per_page = 56; // int | Number of snapshots returned per page (positive integer lower or equal to 100).
$page = 56; // int | Page to be returned.
$name = 'name_example'; // string | List snapshots of the requested name.
$tags = 'tags_example'; // string | List snapshots that have the requested tag.
$base_volume_id = 'base_volume_id_example'; // string | List snapshots originating only from this volume.
try {
$result = $apiInstance->listSnapshots($zone, $organization, $project, $per_page, $page, $name, $tags, $base_volume_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SnapshotsApi->listSnapshots: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **organization** | **string**| List snapshots only for this Organization ID. | [optional] |
| **project** | **string**| List snapshots only for this Project ID. | [optional] |
| **per_page** | **int**| Number of snapshots returned per page (positive integer lower or equal to 100). | [optional] |
| **page** | **int**| Page to be returned. | [optional] |
| **name** | **string**| List snapshots of the requested name. | [optional] |
| **tags** | **string**| List snapshots that have the requested tag. | [optional] |
| **base_volume_id** | **string**| List snapshots originating only from this volume. | [optional] |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1ListSnapshotsResponse**](../Model/ScalewayInstanceV1ListSnapshotsResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `setSnapshot()`
```php
setSnapshot($zone, $snapshot_id, $set_snapshot_request): \OpenAPI\Client\Model\ScalewayInstanceV1SetSnapshotResponse
```
Set snapshot
Replace all the properties of a snapshot.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SnapshotsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$snapshot_id = 'snapshot_id_example'; // string
$set_snapshot_request = new \OpenAPI\Client\Model\SetSnapshotRequest(); // \OpenAPI\Client\Model\SetSnapshotRequest
try {
$result = $apiInstance->setSnapshot($zone, $snapshot_id, $set_snapshot_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SnapshotsApi->setSnapshot: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **snapshot_id** | **string**| | |
| **set_snapshot_request** | [**\OpenAPI\Client\Model\SetSnapshotRequest**](../Model/SetSnapshotRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1SetSnapshotResponse**](../Model/ScalewayInstanceV1SetSnapshotResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `updateSnapshot()`
```php
updateSnapshot($zone, $snapshot_id, $update_snapshot_request): \OpenAPI\Client\Model\ScalewayInstanceV1UpdateSnapshotResponse
```
Update a snapshot
Update the properties of a snapshot.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\SnapshotsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$snapshot_id = 6170692e-7363-616c-6577-61792e636f6d; // string | UUID of the snapshot. (UUID format)
$update_snapshot_request = new \OpenAPI\Client\Model\UpdateSnapshotRequest(); // \OpenAPI\Client\Model\UpdateSnapshotRequest
try {
$result = $apiInstance->updateSnapshot($zone, $snapshot_id, $update_snapshot_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SnapshotsApi->updateSnapshot: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **snapshot_id** | **string**| UUID of the snapshot. (UUID format) | |
| **update_snapshot_request** | [**\OpenAPI\Client\Model\UpdateSnapshotRequest**](../Model/UpdateSnapshotRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1UpdateSnapshotResponse**](../Model/ScalewayInstanceV1UpdateSnapshotResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

273
docs/Api/UserDataApi.md Normal file
View file

@ -0,0 +1,273 @@
# OpenAPI\Client\UserDataApi
All URIs are relative to https://api.scaleway.com, except if the operation defines another base path.
| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**deleteServerUserData()**](UserDataApi.md#deleteServerUserData) | **DELETE** /instance/v1/zones/{zone}/servers/{server_id}/user_data/{key} | Delete user data |
| [**getServerUserData()**](UserDataApi.md#getServerUserData) | **GET** /instance/v1/zones/{zone}/servers/{server_id}/user_data/{key} | Get user data |
| [**listServerUserData()**](UserDataApi.md#listServerUserData) | **GET** /instance/v1/zones/{zone}/servers/{server_id}/user_data | List user data |
| [**setServerUserData()**](UserDataApi.md#setServerUserData) | **PATCH** /instance/v1/zones/{zone}/servers/{server_id}/user_data/{key} | Add/set user data |
## `deleteServerUserData()`
```php
deleteServerUserData($zone, $server_id, $key)
```
Delete user data
Delete the specified key from an Instance's user data.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\UserDataApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$server_id = 'server_id_example'; // string | UUID of the Instance.
$key = 'key_example'; // string | Key of the user data to delete.
try {
$apiInstance->deleteServerUserData($zone, $server_id, $key);
} catch (Exception $e) {
echo 'Exception when calling UserDataApi->deleteServerUserData: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **server_id** | **string**| UUID of the Instance. | |
| **key** | **string**| Key of the user data to delete. | |
### Return type
void (empty response body)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `getServerUserData()`
```php
getServerUserData($zone, $server_id, $key): \OpenAPI\Client\Model\ScalewayStdFile
```
Get user data
Get the content of a user data with the specified key on an Instance.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\UserDataApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$server_id = 'server_id_example'; // string | UUID of the Instance.
$key = 'key_example'; // string | Key of the user data to get.
try {
$result = $apiInstance->getServerUserData($zone, $server_id, $key);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserDataApi->getServerUserData: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **server_id** | **string**| UUID of the Instance. | |
| **key** | **string**| Key of the user data to get. | |
### Return type
[**\OpenAPI\Client\Model\ScalewayStdFile**](../Model/ScalewayStdFile.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `listServerUserData()`
```php
listServerUserData($zone, $server_id): \OpenAPI\Client\Model\ScalewayInstanceV1ListServerUserDataResponse
```
List user data
List all user data keys registered on a specified Instance.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\UserDataApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$server_id = 'server_id_example'; // string | UUID of the Instance.
try {
$result = $apiInstance->listServerUserData($zone, $server_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserDataApi->listServerUserData: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **server_id** | **string**| UUID of the Instance. | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1ListServerUserDataResponse**](../Model/ScalewayInstanceV1ListServerUserDataResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `setServerUserData()`
```php
setServerUserData($zone, $server_id, $key, $body)
```
Add/set user data
Add or update a user data with the specified key on an Instance.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\UserDataApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$server_id = 'server_id_example'; // string | UUID of the Instance.
$key = 'key_example'; // string | Key of the user data to set.
$body = '/path/to/file.txt'; // \SplFileObject
try {
$apiInstance->setServerUserData($zone, $server_id, $key, $body);
} catch (Exception $e) {
echo 'Exception when calling UserDataApi->setServerUserData: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **server_id** | **string**| UUID of the Instance. | |
| **key** | **string**| Key of the user data to set. | |
| **body** | **\SplFileObject****\SplFileObject**| | |
### Return type
void (empty response body)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

View file

@ -0,0 +1,74 @@
# OpenAPI\Client\VolumeTypesApi
All URIs are relative to https://api.scaleway.com, except if the operation defines another base path.
| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**listVolumesTypes()**](VolumeTypesApi.md#listVolumesTypes) | **GET** /instance/v1/zones/{zone}/products/volumes | List volume types |
## `listVolumesTypes()`
```php
listVolumesTypes($zone, $per_page, $page): \OpenAPI\Client\Model\ScalewayInstanceV1ListVolumesTypesResponse
```
List volume types
List all volume types and their technical details.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\VolumeTypesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$per_page = 56; // int
$page = 56; // int
try {
$result = $apiInstance->listVolumesTypes($zone, $per_page, $page);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling VolumeTypesApi->listVolumesTypes: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **per_page** | **int**| | [optional] |
| **page** | **int**| | [optional] |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1ListVolumesTypesResponse**](../Model/ScalewayInstanceV1ListVolumesTypesResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

541
docs/Api/VolumesApi.md Normal file
View file

@ -0,0 +1,541 @@
# OpenAPI\Client\VolumesApi
All URIs are relative to https://api.scaleway.com, except if the operation defines another base path.
| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**applyBlockMigration()**](VolumesApi.md#applyBlockMigration) | **POST** /instance/v1/zones/{zone}/block-migration/apply | Migrate a volume and/or snapshots to SBS (Scaleway Block Storage) |
| [**createVolume()**](VolumesApi.md#createVolume) | **POST** /instance/v1/zones/{zone}/volumes | Create a volume |
| [**deleteVolume()**](VolumesApi.md#deleteVolume) | **DELETE** /instance/v1/zones/{zone}/volumes/{volume_id} | Delete a volume |
| [**getVolume()**](VolumesApi.md#getVolume) | **GET** /instance/v1/zones/{zone}/volumes/{volume_id} | Get a volume |
| [**listVolumes()**](VolumesApi.md#listVolumes) | **GET** /instance/v1/zones/{zone}/volumes | List volumes |
| [**planBlockMigration()**](VolumesApi.md#planBlockMigration) | **POST** /instance/v1/zones/{zone}/block-migration/plan | Get a volume or snapshot&#39;s migration plan |
| [**setVolume()**](VolumesApi.md#setVolume) | **PUT** /instance/v1/zones/{zone}/volumes/{id} | Update volume |
| [**updateVolume()**](VolumesApi.md#updateVolume) | **PATCH** /instance/v1/zones/{zone}/volumes/{volume_id} | Update a volume |
## `applyBlockMigration()`
```php
applyBlockMigration($zone, $apply_block_migration_request)
```
Migrate a volume and/or snapshots to SBS (Scaleway Block Storage)
To be used, the call to this endpoint must be preceded by a call to the [Get a volume or snapshot's migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint. To migrate all resources mentioned in the migration plan, the validation_key returned in the plan must be provided.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\VolumesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$apply_block_migration_request = new \OpenAPI\Client\Model\ApplyBlockMigrationRequest(); // \OpenAPI\Client\Model\ApplyBlockMigrationRequest
try {
$apiInstance->applyBlockMigration($zone, $apply_block_migration_request);
} catch (Exception $e) {
echo 'Exception when calling VolumesApi->applyBlockMigration: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **apply_block_migration_request** | [**\OpenAPI\Client\Model\ApplyBlockMigrationRequest**](../Model/ApplyBlockMigrationRequest.md)| | |
### Return type
void (empty response body)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `createVolume()`
```php
createVolume($zone, $create_volume_request): \OpenAPI\Client\Model\ScalewayInstanceV1CreateVolumeResponse
```
Create a volume
Create a volume of a specified type in an Availability Zone.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\VolumesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$create_volume_request = new \OpenAPI\Client\Model\CreateVolumeRequest(); // \OpenAPI\Client\Model\CreateVolumeRequest
try {
$result = $apiInstance->createVolume($zone, $create_volume_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling VolumesApi->createVolume: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **create_volume_request** | [**\OpenAPI\Client\Model\CreateVolumeRequest**](../Model/CreateVolumeRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1CreateVolumeResponse**](../Model/ScalewayInstanceV1CreateVolumeResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `deleteVolume()`
```php
deleteVolume($zone, $volume_id)
```
Delete a volume
Delete the volume with the specified ID.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\VolumesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$volume_id = 'volume_id_example'; // string | UUID of the volume you want to delete.
try {
$apiInstance->deleteVolume($zone, $volume_id);
} catch (Exception $e) {
echo 'Exception when calling VolumesApi->deleteVolume: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **volume_id** | **string**| UUID of the volume you want to delete. | |
### Return type
void (empty response body)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `getVolume()`
```php
getVolume($zone, $volume_id): \OpenAPI\Client\Model\ScalewayInstanceV1GetVolumeResponse
```
Get a volume
Get details of a volume with the specified ID.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\VolumesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$volume_id = 'volume_id_example'; // string | UUID of the volume you want to get.
try {
$result = $apiInstance->getVolume($zone, $volume_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling VolumesApi->getVolume: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **volume_id** | **string**| UUID of the volume you want to get. | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1GetVolumeResponse**](../Model/ScalewayInstanceV1GetVolumeResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `listVolumes()`
```php
listVolumes($zone, $volume_type, $per_page, $page, $organization, $project, $tags, $name): \OpenAPI\Client\Model\ScalewayInstanceV1ListVolumesResponse
```
List volumes
List volumes in the specified Availability Zone. You can filter the output by volume type.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\VolumesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$volume_type = 'l_ssd'; // string | Filter by volume type.
$per_page = 56; // int | A positive integer lower or equal to 100 to select the number of items to return.
$page = 56; // int | A positive integer to choose the page to return.
$organization = 'organization_example'; // string | Filter volume by Organization ID.
$project = 'project_example'; // string | Filter volume by Project ID.
$tags = 'tags_example'; // string | Filter volumes with these exact tags (to filter with several tags, use commas to separate them).
$name = 'name_example'; // string | Filter volume by name (for eg. \"vol\" will return \"myvolume\" but not \"data\").
try {
$result = $apiInstance->listVolumes($zone, $volume_type, $per_page, $page, $organization, $project, $tags, $name);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling VolumesApi->listVolumes: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **volume_type** | **string**| Filter by volume type. | [optional] [default to &#39;l_ssd&#39;] |
| **per_page** | **int**| A positive integer lower or equal to 100 to select the number of items to return. | [optional] |
| **page** | **int**| A positive integer to choose the page to return. | [optional] |
| **organization** | **string**| Filter volume by Organization ID. | [optional] |
| **project** | **string**| Filter volume by Project ID. | [optional] |
| **tags** | **string**| Filter volumes with these exact tags (to filter with several tags, use commas to separate them). | [optional] |
| **name** | **string**| Filter volume by name (for eg. \&quot;vol\&quot; will return \&quot;myvolume\&quot; but not \&quot;data\&quot;). | [optional] |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1ListVolumesResponse**](../Model/ScalewayInstanceV1ListVolumesResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `planBlockMigration()`
```php
planBlockMigration($zone, $plan_block_migration_request): \OpenAPI\Client\Model\ScalewayInstanceV1MigrationPlan
```
Get a volume or snapshot's migration plan
Given a volume or snapshot, returns the migration plan but does not perform the actual migration. To perform the migration, you have to call the [Migrate a volume and/or snapshots to SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) endpoint afterward. The endpoint returns the resources that should be migrated together: - the volume and any snapshots created from the volume, if the call was made to plan a volume migration. - the base volume of the snapshot (if the volume is not deleted) and its related snapshots, if the call was made to plan a snapshot migration. The endpoint also returns the validation_key, which must be provided to the [Migrate a volume and/or snapshots to SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) endpoint to confirm that all resources listed in the plan should be migrated.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\VolumesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$plan_block_migration_request = new \OpenAPI\Client\Model\PlanBlockMigrationRequest(); // \OpenAPI\Client\Model\PlanBlockMigrationRequest
try {
$result = $apiInstance->planBlockMigration($zone, $plan_block_migration_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling VolumesApi->planBlockMigration: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **plan_block_migration_request** | [**\OpenAPI\Client\Model\PlanBlockMigrationRequest**](../Model/PlanBlockMigrationRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1MigrationPlan**](../Model/ScalewayInstanceV1MigrationPlan.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `setVolume()`
```php
setVolume($zone, $id, $set_volume_request): \OpenAPI\Client\Model\ScalewayInstanceV1SetVolumeResponse
```
Update volume
Replace all volume properties with a volume message.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\VolumesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$id = 'id_example'; // string | Unique ID of the volume.
$set_volume_request = new \OpenAPI\Client\Model\SetVolumeRequest(); // \OpenAPI\Client\Model\SetVolumeRequest
try {
$result = $apiInstance->setVolume($zone, $id, $set_volume_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling VolumesApi->setVolume: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **id** | **string**| Unique ID of the volume. | |
| **set_volume_request** | [**\OpenAPI\Client\Model\SetVolumeRequest**](../Model/SetVolumeRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1SetVolumeResponse**](../Model/ScalewayInstanceV1SetVolumeResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `updateVolume()`
```php
updateVolume($zone, $volume_id, $update_volume_request): \OpenAPI\Client\Model\ScalewayInstanceV1UpdateVolumeResponse
```
Update a volume
Replace the name and/or size properties of a volume specified by its ID, with the specified value(s). Any volume name can be changed, however only `b_ssd` volumes can currently be increased in size.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\VolumesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$zone = 'zone_example'; // string | The zone you want to target
$volume_id = 'volume_id_example'; // string | UUID of the volume.
$update_volume_request = new \OpenAPI\Client\Model\UpdateVolumeRequest(); // \OpenAPI\Client\Model\UpdateVolumeRequest
try {
$result = $apiInstance->updateVolume($zone, $volume_id, $update_volume_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling VolumesApi->updateVolume: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **zone** | **string**| The zone you want to target | |
| **volume_id** | **string**| UUID of the volume. | |
| **update_volume_request** | [**\OpenAPI\Client\Model\UpdateVolumeRequest**](../Model/UpdateVolumeRequest.md)| | |
### Return type
[**\OpenAPI\Client\Model\ScalewayInstanceV1UpdateVolumeResponse**](../Model/ScalewayInstanceV1UpdateVolumeResponse.md)
### Authorization
[scaleway](../../README.md#scaleway)
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

View file

@ -0,0 +1,11 @@
# # ApplyBlockMigrationRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**volume_id** | **string** | The volume to migrate, along with potentially other resources, according to the migration plan generated with a call to the [Get a volume or snapshot&#39;s migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint. | [optional]
**snapshot_id** | **string** | The snapshot to migrate, along with potentially other resources, according to the migration plan generated with a call to the [Get a volume or snapshot&#39;s migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint. | [optional]
**validation_key** | **string** | A value to be retrieved from a call to the [Get a volume or snapshot&#39;s migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint, to confirm that the volume and/or snapshots specified in said plan should be migrated. |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,11 @@
# # AttachServerVolumeRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**volume_id** | **string** | | [optional]
**volume_type** | [**\OpenAPI\Client\Model\ScalewayInstanceV1AttachServerVolumeRequestVolumeType**](ScalewayInstanceV1AttachServerVolumeRequestVolumeType.md) | | [optional]
**boot** | **bool** | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # CheckBlockMigrationOrganizationQuotasRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**organization** | **string** | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,16 @@
# # CreateImageRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | Name of the image. | [optional]
**root_volume** | **string** | UUID of the snapshot. |
**arch** | **string** | Architecture of the image. | [default to 'unknown_arch']
**extra_volumes** | [**\OpenAPI\Client\Model\CreateImageRequestExtraVolumes**](CreateImageRequestExtraVolumes.md) | | [optional]
**organization** | **string** | Organization ID of the image. | [optional]
**project** | **string** | Project ID of the image. | [optional]
**tags** | **string[]** | Tags of the image. | [optional]
**public** | **bool** | True to create a public image. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # CreateImageRequestExtraVolumes
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**extra_volume_key** | [**\OpenAPI\Client\Model\ScalewayInstanceV1VolumeTemplate**](ScalewayInstanceV1VolumeTemplate.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,13 @@
# # CreateIpRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**organization** | **string** | Organization ID in which the IP is reserved. | [optional]
**project** | **string** | Project ID in which the IP is reserved. | [optional]
**tags** | **string[]** | Tags of the IP. | [optional]
**server** | **string** | UUID of the Instance you want to attach the IP to. | [optional]
**type** | **string** | IP type to reserve (either &#39;routed_ipv4&#39; or &#39;routed_ipv6&#39;). | [optional] [default to 'unknown_iptype']
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,14 @@
# # CreatePlacementGroupRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | Name of the placement group. | [optional]
**organization** | **string** | Organization ID of the placement group. | [optional]
**project** | **string** | Project ID of the placement group. | [optional]
**tags** | **string[]** | Tags of the placement group. | [optional]
**policy_mode** | **string** | Operating mode of the placement group. | [optional] [default to 'optional']
**policy_type** | **string** | Policy type of the placement group. | [optional] [default to 'max_availability']
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,11 @@
# # CreatePrivateNICRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**private_network_id** | **string** | UUID of the private network where the private NIC will be attached. |
**tags** | **string[]** | Private NIC tags. | [optional]
**ipam_ip_ids** | **string[]** | UUID of IPAM ips, to be attached to the instance in the requested private network. (UUID format) | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,19 @@
# # CreateSecurityGroupRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | Name of the security group. |
**description** | **string** | Description of the security group. | [optional]
**organization** | **string** | Organization ID the security group belongs to. | [optional]
**project** | **string** | Project ID the security group belong to. | [optional]
**tags** | **string[]** | Tags of the security group. | [optional]
**organization_default** | **bool** | Defines whether this security group becomes the default security group for new Instances. | [optional]
**project_default** | **bool** | Whether this security group becomes the default security group for new Instances. | [optional]
**stateful** | **bool** | Whether the security group is stateful or not. | [optional] [default to false]
**inbound_default_policy** | **string** | Default policy for inbound rules. | [optional] [default to 'accept']
**outbound_default_policy** | **string** | Default policy for outbound rules. | [optional] [default to 'accept']
**enable_default_security** | **bool** | True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,16 @@
# # CreateSecurityGroupRuleRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**protocol** | [**\OpenAPI\Client\Model\ScalewayInstanceV1SecurityGroupRuleProtocol**](ScalewayInstanceV1SecurityGroupRuleProtocol.md) | |
**direction** | [**\OpenAPI\Client\Model\ScalewayInstanceV1SecurityGroupRuleDirection**](ScalewayInstanceV1SecurityGroupRuleDirection.md) | |
**action** | [**\OpenAPI\Client\Model\ScalewayInstanceV1SecurityGroupRuleAction**](ScalewayInstanceV1SecurityGroupRuleAction.md) | |
**ip_range** | **string** | (IP network) |
**dest_port_from** | **int** | Beginning of the range of ports to apply this rule to (inclusive). | [optional]
**dest_port_to** | **int** | End of the range of ports to apply this rule to (inclusive). | [optional]
**position** | **int** | Position of this rule in the security group rules list. | [optional]
**editable** | **bool** | Indicates if this rule is editable (will be ignored). | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,24 @@
# # CreateServerRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | Instance name. |
**dynamic_ip_required** | **bool** | Define if a dynamic IPv4 is required for the Instance. | [optional]
**routed_ip_enabled** | **bool** | If true, configure the Instance so it uses the new routed IP mode. | [optional]
**commercial_type** | **string** | Define the Instance commercial type (i.e. GP1-S). |
**image** | **string** | Instance image ID or label. When an image label is used, it will be converted to the latest image available on the Marketplace. By default, the selected local image will be the instance_sbs local image. If an l_ssd or b_ssd volume is specified in the volumes argument, an instance_local local image will be selected instead. | [optional]
**volumes** | [**\OpenAPI\Client\Model\CreateServerRequestVolumes**](CreateServerRequestVolumes.md) | | [optional]
**enable_ipv6** | **bool** | True if IPv6 is enabled on the server (deprecated and always &#x60;False&#x60; when &#x60;routed_ip_enabled&#x60; is &#x60;True&#x60;). | [optional]
**public_ip** | **string** | ID of the reserved IP to attach to the Instance. | [optional]
**public_ips** | **string[]** | A list of reserved IP IDs to attach to the Instance. | [optional]
**boot_type** | **string** | Boot type to use. | [optional] [default to 'local']
**organization** | **string** | Instance Organization ID. | [optional]
**project** | **string** | Instance Project ID. | [optional]
**tags** | **string[]** | Instance tags. | [optional]
**security_group** | **string** | Security group ID. | [optional]
**placement_group** | **string** | Placement group ID if Instance must be part of a placement group. | [optional]
**admin_password_encryption_ssh_key_id** | **string** | UUID of the SSH RSA key that will be used to encrypt the initial admin password for OS requiring it. Mandatory for Windows OS. The public_key value of this key is used to encrypt the admin password. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # CreateServerRequestVolumes
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**volume_key** | [**\OpenAPI\Client\Model\ScalewayInstanceV1VolumeServerTemplate**](ScalewayInstanceV1VolumeServerTemplate.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,17 @@
# # CreateSnapshotRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | Name of the snapshot. | [optional]
**volume_id** | **string** | UUID of the volume. | [optional]
**tags** | **string[]** | Tags of the snapshot. | [optional]
**organization** | **string** | Organization ID of the snapshot. | [optional]
**project** | **string** | Project ID of the snapshot. | [optional]
**volume_type** | **string** | Volume type of the snapshot. Overrides the volume_type of the snapshot. If omitted, the volume type of the original volume will be used. | [optional] [default to 'unknown_volume_type']
**bucket** | **string** | Bucket name for snapshot imports. | [optional]
**key** | **string** | Object key for snapshot imports. | [optional]
**size** | **int** | Imported snapshot size, must be a multiple of 512. (in bytes) | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,15 @@
# # CreateVolumeRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | Volume name. | [optional]
**organization** | **string** | Volume Organization ID. | [optional]
**project** | **string** | Volume Project ID. | [optional]
**tags** | **string[]** | Volume tags. | [optional]
**volume_type** | **string** | Volume type. | [optional] [default to 'l_ssd']
**size** | **int** | Volume disk size, must be a multiple of 512. (in bytes) | [optional]
**base_snapshot** | **string** | ID of the snapshot on which this volume will be based. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # DetachServerVolumeRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**volume_id** | **string** | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,10 @@
# # ExportSnapshotRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bucket** | **string** | Object Storage bucket name. | [optional]
**key** | **string** | Object key. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,10 @@
# # PlanBlockMigrationRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**volume_id** | **string** | The volume for which the migration plan will be generated. | [optional]
**snapshot_id** | **string** | The snapshot for which the migration plan will be generated. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,8 @@
# # ScalewayInstanceV1Arch
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,8 @@
# # ScalewayInstanceV1AttachServerVolumeRequestVolumeType
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1AttachServerVolumeResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**server** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Server**](ScalewayInstanceV1Server.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,8 @@
# # ScalewayInstanceV1BootType
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,20 @@
# # ScalewayInstanceV1Bootscript
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**architecture** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Arch**](ScalewayInstanceV1Arch.md) | | [optional]
**bootcmdargs** | **string** | | [optional]
**default** | **bool** | | [optional]
**dtb** | **string** | | [optional]
**id** | **string** | | [optional]
**initrd** | **string** | | [optional]
**kernel** | **string** | | [optional]
**organization** | **string** | | [optional]
**public** | **bool** | | [optional]
**title** | **string** | | [optional]
**project** | **string** | | [optional]
**zone** | **string** | The zone you want to target | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1CreateImageResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**image** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Image**](ScalewayInstanceV1Image.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1CreateIpResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ip** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Ip**](ScalewayInstanceV1Ip.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1CreatePlacementGroupResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**placement_group** | [**\OpenAPI\Client\Model\ScalewayInstanceV1PlacementGroup**](ScalewayInstanceV1PlacementGroup.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1CreatePrivateNICResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**private_nic** | [**\OpenAPI\Client\Model\ScalewayInstanceV1PrivateNIC**](ScalewayInstanceV1PrivateNIC.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1CreateSecurityGroupResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**security_group** | [**\OpenAPI\Client\Model\ScalewayInstanceV1SecurityGroup**](ScalewayInstanceV1SecurityGroup.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1CreateSecurityGroupRuleResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rule** | [**\OpenAPI\Client\Model\ScalewayInstanceV1SecurityGroupRule**](ScalewayInstanceV1SecurityGroupRule.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1CreateServerResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**server** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Server**](ScalewayInstanceV1Server.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,10 @@
# # ScalewayInstanceV1CreateSnapshotResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**snapshot** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Snapshot**](ScalewayInstanceV1Snapshot.md) | | [optional]
**task** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Task**](ScalewayInstanceV1Task.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1CreateVolumeResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**volume** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Volume**](ScalewayInstanceV1Volume.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,23 @@
# # ScalewayInstanceV1Dashboard
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**volumes_count** | **int** | | [optional]
**running_servers_count** | **int** | | [optional]
**servers_by_types** | [**\OpenAPI\Client\Model\ScalewayInstanceV1DashboardServersByTypes**](ScalewayInstanceV1DashboardServersByTypes.md) | | [optional]
**images_count** | **int** | | [optional]
**snapshots_count** | **int** | | [optional]
**servers_count** | **int** | | [optional]
**ips_count** | **int** | | [optional]
**security_groups_count** | **int** | | [optional]
**ips_unused** | **int** | | [optional]
**volumes_l_ssd_count** | **int** | | [optional]
**volumes_b_ssd_count** | **int** | | [optional]
**volumes_l_ssd_total_size** | **int** | (in bytes) | [optional]
**volumes_b_ssd_total_size** | **int** | (in bytes) | [optional]
**private_nics_count** | **int** | | [optional]
**placement_groups_count** | **int** | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1DashboardServersByTypes
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**servers_by_type_key** | **int** | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1DetachServerVolumeResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**server** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Server**](ScalewayInstanceV1Server.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1ExportSnapshotResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**task** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Task**](ScalewayInstanceV1Task.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1GetDashboardResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**dashboard** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Dashboard**](ScalewayInstanceV1Dashboard.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1GetImageResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**image** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Image**](ScalewayInstanceV1Image.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1GetIpResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ip** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Ip**](ScalewayInstanceV1Ip.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1GetPlacementGroupResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**placement_group** | [**\OpenAPI\Client\Model\ScalewayInstanceV1PlacementGroup**](ScalewayInstanceV1PlacementGroup.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1GetPlacementGroupServersResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**servers** | [**\OpenAPI\Client\Model\ScalewayInstanceV1PlacementGroupServer[]**](ScalewayInstanceV1PlacementGroupServer.md) | Instances attached to the placement group. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1GetPrivateNICResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**private_nic** | [**\OpenAPI\Client\Model\ScalewayInstanceV1PrivateNIC**](ScalewayInstanceV1PrivateNIC.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1GetSecurityGroupResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**security_group** | [**\OpenAPI\Client\Model\ScalewayInstanceV1SecurityGroup**](ScalewayInstanceV1SecurityGroup.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1GetSecurityGroupRuleResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rule** | [**\OpenAPI\Client\Model\ScalewayInstanceV1SecurityGroupRule**](ScalewayInstanceV1SecurityGroupRule.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1GetServerResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**server** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Server**](ScalewayInstanceV1Server.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1GetServerTypesAvailabilityResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**servers** | [**\OpenAPI\Client\Model\ScalewayInstanceV1GetServerTypesAvailabilityResponseServers**](ScalewayInstanceV1GetServerTypesAvailabilityResponseServers.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1GetServerTypesAvailabilityResponseAvailability
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**availability** | [**\OpenAPI\Client\Model\ScalewayInstanceV1ServerTypesAvailability**](ScalewayInstanceV1ServerTypesAvailability.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1GetServerTypesAvailabilityResponseServers
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**server_key** | [**\OpenAPI\Client\Model\ScalewayInstanceV1GetServerTypesAvailabilityResponseAvailability**](ScalewayInstanceV1GetServerTypesAvailabilityResponseAvailability.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1GetSnapshotResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**snapshot** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Snapshot**](ScalewayInstanceV1Snapshot.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1GetVolumeResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**volume** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Volume**](ScalewayInstanceV1Volume.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,23 @@
# # ScalewayInstanceV1Image
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | | [optional]
**name** | **string** | | [optional]
**arch** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Arch**](ScalewayInstanceV1Arch.md) | | [optional]
**creation_date** | **\DateTime** | (RFC 3339 format) | [optional]
**modification_date** | **\DateTime** | (RFC 3339 format) | [optional]
**default_bootscript** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Bootscript**](ScalewayInstanceV1Bootscript.md) | | [optional]
**extra_volumes** | [**\OpenAPI\Client\Model\SetImageRequestExtraVolumes**](SetImageRequestExtraVolumes.md) | | [optional]
**from_server** | **string** | | [optional]
**organization** | **string** | | [optional]
**public** | **bool** | | [optional]
**root_volume** | [**\OpenAPI\Client\Model\ScalewayInstanceV1VolumeSummary**](ScalewayInstanceV1VolumeSummary.md) | | [optional]
**state** | [**\OpenAPI\Client\Model\ScalewayInstanceV1ImageState**](ScalewayInstanceV1ImageState.md) | | [optional]
**project** | **string** | | [optional]
**tags** | **string[]** | | [optional]
**zone** | **string** | The zone you want to target | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,8 @@
# # ScalewayInstanceV1ImageState
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,20 @@
# # ScalewayInstanceV1Ip
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | | [optional]
**address** | **string** | (IP address) | [optional]
**reverse** | **string** | | [optional]
**server** | [**\OpenAPI\Client\Model\ScalewayInstanceV1ServerSummary**](ScalewayInstanceV1ServerSummary.md) | | [optional]
**organization** | **string** | | [optional]
**tags** | **string[]** | | [optional]
**project** | **string** | | [optional]
**type** | [**\OpenAPI\Client\Model\ScalewayInstanceV1IpType**](ScalewayInstanceV1IpType.md) | | [optional]
**state** | [**\OpenAPI\Client\Model\ScalewayInstanceV1IpState**](ScalewayInstanceV1IpState.md) | | [optional]
**prefix** | **string** | (IP network) | [optional]
**ipam_id** | **string** | (UUID format) | [optional]
**zone** | **string** | The zone you want to target | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,8 @@
# # ScalewayInstanceV1IpState
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,8 @@
# # ScalewayInstanceV1IpType
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1ListImagesResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**images** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Image[]**](ScalewayInstanceV1Image.md) | List of images. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1ListIpsResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ips** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Ip[]**](ScalewayInstanceV1Ip.md) | List of ips. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1ListPlacementGroupsResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**placement_groups** | [**\OpenAPI\Client\Model\ScalewayInstanceV1PlacementGroup[]**](ScalewayInstanceV1PlacementGroup.md) | List of placement groups. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,10 @@
# # ScalewayInstanceV1ListPrivateNICsResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**private_nics** | [**\OpenAPI\Client\Model\ScalewayInstanceV1PrivateNIC[]**](ScalewayInstanceV1PrivateNIC.md) | | [optional]
**total_count** | **int** | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1ListSecurityGroupRulesResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rules** | [**\OpenAPI\Client\Model\ScalewayInstanceV1SecurityGroupRule[]**](ScalewayInstanceV1SecurityGroupRule.md) | List of security rules. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1ListSecurityGroupsResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**security_groups** | [**\OpenAPI\Client\Model\ScalewayInstanceV1SecurityGroup[]**](ScalewayInstanceV1SecurityGroup.md) | List of security groups. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1ListServerActionsResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**actions** | [**\OpenAPI\Client\Model\ScalewayInstanceV1ServerAction[]**](ScalewayInstanceV1ServerAction.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1ListServerUserDataResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**user_data** | **string[]** | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1ListServersResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**servers** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Server[]**](ScalewayInstanceV1Server.md) | List of Instances. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1ListServersTypesResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**servers** | [**\OpenAPI\Client\Model\ScalewayInstanceV1ListServersTypesResponseServers**](ScalewayInstanceV1ListServersTypesResponseServers.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1ListServersTypesResponseServers
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**server_key** | [**\OpenAPI\Client\Model\ScalewayInstanceV1ServerType**](ScalewayInstanceV1ServerType.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1ListSnapshotsResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**snapshots** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Snapshot[]**](ScalewayInstanceV1Snapshot.md) | List of snapshots. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1ListVolumesResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**volumes** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Volume[]**](ScalewayInstanceV1Volume.md) | List of volumes. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1ListVolumesTypesResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**volumes** | [**\OpenAPI\Client\Model\ScalewayInstanceV1ListVolumesTypesResponseVolumes**](ScalewayInstanceV1ListVolumesTypesResponseVolumes.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,9 @@
# # ScalewayInstanceV1ListVolumesTypesResponseVolumes
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**volume_key** | [**\OpenAPI\Client\Model\ScalewayInstanceV1VolumeType**](ScalewayInstanceV1VolumeType.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,11 @@
# # ScalewayInstanceV1MigrationPlan
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**volume** | [**\OpenAPI\Client\Model\ScalewayInstanceV1MigrationPlanVolume**](ScalewayInstanceV1MigrationPlanVolume.md) | | [optional]
**snapshots** | [**\OpenAPI\Client\Model\ScalewayInstanceV1Snapshot[]**](ScalewayInstanceV1Snapshot.md) | A list of snapshots which will be migrated to SBS together and with the volume, if present. | [optional]
**validation_key** | **string** | A value to be passed to the call to the [Migrate a volume and/or snapshots to SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) endpoint, to confirm that the execution of the plan is being requested. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,21 @@
# # ScalewayInstanceV1MigrationPlanVolume
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Volume unique ID. | [optional]
**name** | **string** | Volume name. | [optional]
**export_uri** | **string** | Show the volume NBD export URI. | [optional]
**size** | **int** | Volume disk size. (in bytes) | [optional]
**volume_type** | **string** | Volume type. | [optional] [default to 'l_ssd']
**creation_date** | **\DateTime** | Volume creation date. (RFC 3339 format) | [optional]
**modification_date** | **\DateTime** | Volume modification date. (RFC 3339 format) | [optional]
**organization** | **string** | Volume Organization ID. | [optional]
**project** | **string** | Volume Project ID. | [optional]
**tags** | **string[]** | Volume tags. | [optional]
**server** | [**\OpenAPI\Client\Model\SetVolumeRequestServer**](SetVolumeRequestServer.md) | | [optional]
**state** | **string** | Volume state. | [optional] [default to 'available']
**zone** | **string** | Zone in which the volume is located. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,17 @@
# # ScalewayInstanceV1PlacementGroup
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Placement group unique ID. | [optional]
**name** | **string** | Placement group name. | [optional]
**organization** | **string** | Placement group Organization ID. | [optional]
**project** | **string** | Placement group Project ID. | [optional]
**tags** | **string[]** | Placement group tags. | [optional]
**policy_mode** | **string** | Select the failure mode when the placement cannot be respected, either optional or enforced. | [optional] [default to 'optional']
**policy_type** | **string** | Select the behavior of the placement group, either low_latency (group) or max_availability (spread). | [optional] [default to 'max_availability']
**policy_respected** | **bool** | True if the policy is respected, false otherwise. In the server endpoints the value is always false as it is deprecated. In the placement group endpoints the value is correct. | [optional]
**zone** | **string** | Zone in which the placement group is located. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

View file

@ -0,0 +1,8 @@
# # ScalewayInstanceV1PlacementGroupPolicyMode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

Some files were not shown because too many files have changed in this diff Show more