Download the PHP package contabo/contabo-sdk without Composer
On this page you can find all versions of the php package contabo/contabo-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package contabo-sdk
SwaggerClient-php
Introduction Contabo API allows you to manage your resources using HTTP requests. This documentation includes a set of HTTP endpoints that are designed to RESTful principles. Each endpoint includes descriptions, request syntax, and examples. Contabo provides also a CLI tool which enables you to manage your resources easily from the command line. CLI Download and Installation instructions. ## Product documentation If you are looking for description about the products themselves and their usage in general or for specific purposes, please check the Contabo Product Documentation. ## Getting Started In order to use the Contabo API you will need the following credentials which are available from the Customer Control Panel: 1. ClientId 2. ClientSecret 3. API User (your email address to login to the Customer Control Panel) 4. API Password (this is a new password which you'll set or change in the Customer Control Panel) You can either use the API directly or by using the cntb
CLI (Command Line Interface) tool. ### Using the API directly #### Via curl
for Linux/Unix like systems This requires curl
and jq
in your shell (e.g. bash
, zsh
). Please replace the first four placeholders with actual values. #### Via PowerShell
for Windows Please open PowerShell
and execute the following code after replacing the first four placeholders with actual values. ### Using the Contabo API via the cntb
CLI tool 1. Download cntb
for your operating system (MacOS, Windows and Linux supported) here 2. Unzip the downloaded file 3. You might move the executable to any location on your disk. You may update your PATH
environment variable for easier invocation. 4. Configure it once to use your credentials 5. Use the CLI ## API Overview ### Contabo.
This PHP package is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen For more information, please visit https://contabo.com
Requirements
PHP 5.5 and later
Installation & Usage
Composer
To install the bindings via Composer, add the following to composer.json
:
Then run composer install
Manual Installation
Download the files and include autoload.php
:
Tests
To run the unit tests:
Getting Started
Please follow the installation procedure and then run the following:
Documentation for API Endpoints
All URIs are relative to https://api.contabo.com
Class | Method | HTTP request | Description |
---|---|---|---|
ImagesApi | createCustomImage | POST /v1/compute/images | Provide a custom image |
ImagesApi | deleteImage | DELETE /v1/compute/images/{imageId} | Delete an uploaded custom image by its id |
ImagesApi | retrieveCustomImagesStats | GET /v1/compute/images/stats | List statistics regarding the customer's custom images |
ImagesApi | retrieveImage | GET /v1/compute/images/{imageId} | Get details about a specific image by its id |
ImagesApi | retrieveImageList | GET /v1/compute/images | List available standard and custom images |
ImagesApi | updateImage | PATCH /v1/compute/images/{imageId} | Update custom image name by its id |
ImagesAuditsApi | retrieveImageAuditsList | GET /v1/compute/images/audits | List history about your custom images (audit) |
InstanceActionsApi | rescue | POST /v1/compute/instances/{instanceId}/actions/rescue | Rescue a compute instance / resource identified by its id |
InstanceActionsApi | resetPasswordAction | POST /v1/compute/instances/{instanceId}/actions/resetPassword | Reset password for a compute instance / resource referenced by an id |
InstanceActionsApi | restart | POST /v1/compute/instances/{instanceId}/actions/restart | Retrieve a list of your custom images history. |
InstanceActionsApi | shutdown | POST /v1/compute/instances/{instanceId}/actions/shutdown | Shutdown compute instance / resource by its id |
InstanceActionsApi | start | POST /v1/compute/instances/{instanceId}/actions/start | Start a compute instance / resource identified by its id |
InstanceActionsApi | stop | POST /v1/compute/instances/{instanceId}/actions/stop | Stop compute instance / resource by its id |
InstanceActionsAuditsApi | retrieveInstancesActionsAuditsList | GET /v1/compute/instances/actions/audits | List history about your actions (audit) triggered via the API |
InstancesApi | cancelInstance | POST /v1/compute/instances/{instanceId}/cancel | Cancel specific instance by id |
InstancesApi | createInstance | POST /v1/compute/instances | Create a new instance |
InstancesApi | patchInstance | PATCH /v1/compute/instances/{instanceId} | Update specific instance |
InstancesApi | reinstallInstance | PUT /v1/compute/instances/{instanceId} | Reinstall specific instance |
InstancesApi | retrieveInstance | GET /v1/compute/instances/{instanceId} | Get specific instance by id |
InstancesApi | retrieveInstancesList | GET /v1/compute/instances | List instances |
InstancesApi | upgradeInstance | POST /v1/compute/instances/{instanceId}/upgrade | Upgrading instance capabilities |
InstancesAuditsApi | retrieveInstancesAuditsList | GET /v1/compute/instances/audits | List history about your custom images (audit) |
InternalApi | createTicket | POST /v1/create-ticket | Create a new support ticket |
InternalApi | retrieveUserIsPasswordSet | GET /v1/users/is-password-set | Get user is password set status |
ObjectStoragesApi | cancelObjectStorage | PATCH /v1/object-storages/{objectStorageId}/cancel | Cancels the specified object storage at the next possible date |
ObjectStoragesApi | createObjectStorage | POST /v1/object-storages | Create a new object storage |
ObjectStoragesApi | retrieveDataCenterList | GET /v1/data-centers | List data centers |
ObjectStoragesApi | retrieveObjectStorage | GET /v1/object-storages/{objectStorageId} | Get specific object storage by its id |
ObjectStoragesApi | retrieveObjectStorageList | GET /v1/object-storages | List all your object storages |
ObjectStoragesApi | retrieveObjectStoragesStats | GET /v1/object-storages/{objectStorageId}/stats | List usage statistics about the specified object storage |
ObjectStoragesApi | updateObjectStorage | PATCH /v1/object-storages/{objectStorageId} | Modifies the display name of object storage |
ObjectStoragesApi | upgradeObjectStorage | POST /v1/object-storages/{objectStorageId}/resize | Upgrade object storage size resp. update autoscaling settings. |
ObjectStoragesAuditsApi | retrieveObjectStorageAuditsList | GET /v1/object-storages/audits | List history about your object storages (audit) |
PrivateNetworksApi | assignInstancePrivateNetwork | POST /v1/private-networks/{privateNetworkId}/instances/{instanceId} | Add instance to a Private Network |
PrivateNetworksApi | createPrivateNetwork | POST /v1/private-networks | Create a new Private Network |
PrivateNetworksApi | deletePrivateNetwork | DELETE /v1/private-networks/{privateNetworkId} | Delete existing Private Network by id |
PrivateNetworksApi | patchPrivateNetwork | PATCH /v1/private-networks/{privateNetworkId} | Update a Private Network by id |
PrivateNetworksApi | retrievePrivateNetwork | GET /v1/private-networks/{privateNetworkId} | Get specific Private Network by id |
PrivateNetworksApi | retrievePrivateNetworkList | GET /v1/private-networks | List Private Networks |
PrivateNetworksApi | unassignInstancePrivateNetwork | DELETE /v1/private-networks/{privateNetworkId}/instances/{instanceId} | Remove instance from a Private Network |
PrivateNetworksAuditsApi | retrievePrivateNetworkAuditsList | GET /v1/private-networks/audits | List history about your Private Networks (audit) |
RolesApi | createRole | POST /v1/roles | Create a new role |
RolesApi | deleteRole | DELETE /v1/roles/{roleId} | Delete existing role by id |
RolesApi | retrieveApiPermissionsList | GET /v1/roles/api-permissions | List of API permissions |
RolesApi | retrieveRole | GET /v1/roles/{roleId} | Get specific role by id |
RolesApi | retrieveRoleList | GET /v1/roles | List roles |
RolesApi | updateRole | PUT /v1/roles/{roleId} | Update specific role by id |
RolesAuditsApi | retrieveRoleAuditsList | GET /v1/roles/audits | List history about your roles (audit) |
SecretsApi | createSecret | POST /v1/secrets | Create a new secret |
SecretsApi | deleteSecret | DELETE /v1/secrets/{secretId} | Delete existing secret by id |
SecretsApi | retrieveSecret | GET /v1/secrets/{secretId} | Get specific secret by id |
SecretsApi | retrieveSecretList | GET /v1/secrets | List secrets |
SecretsApi | updateSecret | PATCH /v1/secrets/{secretId} | Update specific secret by id |
SecretsAuditsApi | retrieveSecretAuditsList | GET /v1/secrets/audits | List history about your secrets (audit) |
SnapshotsApi | createSnapshot | POST /v1/compute/instances/{instanceId}/snapshots | Create a new instance snapshot |
SnapshotsApi | deleteSnapshot | DELETE /v1/compute/instances/{instanceId}/snapshots/{snapshotId} | Delete existing snapshot by id |
SnapshotsApi | retrieveSnapshot | GET /v1/compute/instances/{instanceId}/snapshots/{snapshotId} | Retrieve a specific snapshot by id |
SnapshotsApi | retrieveSnapshotList | GET /v1/compute/instances/{instanceId}/snapshots | List snapshots |
SnapshotsApi | rollbackSnapshot | POST /v1/compute/instances/{instanceId}/snapshots/{snapshotId}/rollback | Revert the instance to a particular snapshot based on its identifier |
SnapshotsApi | updateSnapshot | PATCH /v1/compute/instances/{instanceId}/snapshots/{snapshotId} | Update specific snapshot by id |
SnapshotsAuditsApi | retrieveSnapshotsAuditsList | GET /v1/compute/snapshots/audits | List history about your snapshots (audit) triggered via the API |
TagAssignmentsApi | createAssignment | POST /v1/tags/{tagId}/assignments/{resourceType}/{resourceId} | Create a new assignment for the tag |
TagAssignmentsApi | deleteAssignment | DELETE /v1/tags/{tagId}/assignments/{resourceType}/{resourceId} | Delete existing tag assignment |
TagAssignmentsApi | retrieveAssignment | GET /v1/tags/{tagId}/assignments/{resourceType}/{resourceId} | Get specific assignment for the tag |
TagAssignmentsApi | retrieveAssignmentList | GET /v1/tags/{tagId}/assignments | List tag assignments |
TagAssignmentsAuditsApi | retrieveAssignmentsAuditsList | GET /v1/tags/assignments/audits | List history about your assignments (audit) |
TagsApi | createTag | POST /v1/tags | Create a new tag |
TagsApi | deleteTag | DELETE /v1/tags/{tagId} | Delete existing tag by id |
TagsApi | retrieveTag | GET /v1/tags/{tagId} | Get specific tag by id |
TagsApi | retrieveTagList | GET /v1/tags | List tags |
TagsApi | updateTag | PATCH /v1/tags/{tagId} | Update specific tag by id |
TagsAuditsApi | retrieveTagAuditsList | GET /v1/tags/audits | List history about your assignments (audit) |
UsersApi | createUser | POST /v1/users | Create a new user |
UsersApi | deleteUser | DELETE /v1/users/{userId} | Delete existing user by id |
UsersApi | generateClientSecret | PUT /v1/users/client/secret | Generate new client secret |
UsersApi | getObjectStorageCredentials | GET /v1/users/{userId}/object-storages/{objectStorageId}/credentials/{credentialId} | Get S3 compatible object storage credentials. |
UsersApi | listObjectStorageCredentials | GET /v1/users/{userId}/object-storages/credentials | Get list of S3 compatible object storage credentials for user. |
UsersApi | regenerateObjectStorageCredentials | PATCH /v1/users/{userId}/object-storages/{objectStorageId}/credentials/{credentialId} | Regenerates secret key of specified user for the S3 compatible object storages. |
UsersApi | resendEmailVerification | POST /v1/users/{userId}/resend-email-verification | Resend email verification |
UsersApi | resetPassword | POST /v1/users/{userId}/reset-password | Send reset password email |
UsersApi | retrieveUser | GET /v1/users/{userId} | Get specific user by id |
UsersApi | retrieveUserClient | GET /v1/users/client | Get client |
UsersApi | retrieveUserList | GET /v1/users | List users |
UsersApi | updateUser | PATCH /v1/users/{userId} | Update specific user by id |
UsersAuditsApi | retrieveUserAuditsList | GET /v1/users/audits | List history about your users (audit) |
Documentation For Models
- AddOnQuantityRequest
- AddOnRequest
- AddOnResponse
- AdditionalIp
- AllOfAssignInstancePrivateNetworkResponseLinks
- AllOfCancelInstanceResponseLinks
- AllOfCancelObjectStorageResponseLinks
- AllOfCreateAssignmentResponseLinks
- AllOfCreateCustomImageResponseLinks
- AllOfCreateInstanceAddonsExtraStorage
- AllOfCreateInstanceRequestAddOns
- AllOfCreateInstanceResponseLinks
- AllOfCreateObjectStorageRequestAutoScaling
- AllOfCreateObjectStorageResponseDataAutoScaling
- AllOfCreateObjectStorageResponseLinks
- AllOfCreatePrivateNetworkResponseLinks
- AllOfCreateRoleResponseLinks
- AllOfCreateSecretResponseLinks
- AllOfCreateSnapshotResponseLinks
- AllOfCreateTagResponseLinks
- AllOfCreateTicketResponseLinks
- AllOfCreateUserResponseLinks
- AllOfCustomImagesStatsResponseLinks
- AllOfFindAssignmentResponseLinks
- AllOfFindClientResponseLinks
- AllOfFindCredentialResponseLinks
- AllOfFindImageResponseLinks
- AllOfFindInstanceResponseLinks
- AllOfFindObjectStorageResponseLinks
- AllOfFindPrivateNetworkResponseLinks
- AllOfFindRoleResponseLinks
- AllOfFindSecretResponseLinks
- AllOfFindSnapshotResponseLinks
- AllOfFindTagResponseLinks
- AllOfFindUserIsPasswordSetResponseLinks
- AllOfFindUserResponseLinks
- AllOfFindVncResponseLinks
- AllOfGenerateClientSecretResponseLinks
- AllOfImageAuditResponseLinks
- AllOfImageAuditResponsePagination
- AllOfInstanceRescueActionResponseLinks
- AllOfInstanceResetPasswordActionResponseLinks
- AllOfInstanceRestartActionResponseLinks
- AllOfInstanceShutdownActionResponseLinks
- AllOfInstanceStartActionResponseLinks
- AllOfInstanceStopActionResponseLinks
- AllOfListApiPermissionResponseLinks
- AllOfListAssignmentAuditsResponseLinks
- AllOfListAssignmentAuditsResponsePagination
- AllOfListAssignmentResponseLinks
- AllOfListAssignmentResponsePagination
- AllOfListCredentialResponseLinks
- AllOfListCredentialResponsePagination
- AllOfListDataCenterResponseLinks
- AllOfListDataCenterResponsePagination
- AllOfListImageResponseLinks
- AllOfListImageResponsePagination
- AllOfListInstancesActionsAuditResponseLinks
- AllOfListInstancesActionsAuditResponsePagination
- AllOfListInstancesAuditResponseLinks
- AllOfListInstancesAuditResponsePagination
- AllOfListInstancesResponseLinks
- AllOfListInstancesResponsePagination
- AllOfListObjectStorageAuditResponseLinks
- AllOfListObjectStorageAuditResponsePagination
- AllOfListObjectStorageResponseLinks
- AllOfListObjectStorageResponsePagination
- AllOfListPrivateNetworkAuditResponseLinks
- AllOfListPrivateNetworkAuditResponsePagination
- AllOfListPrivateNetworkResponseLinks
- AllOfListPrivateNetworkResponsePagination
- AllOfListRoleAuditResponseLinks
- AllOfListRoleResponseLinks
- AllOfListRoleResponsePagination
- AllOfListSecretAuditResponseLinks
- AllOfListSecretAuditResponsePagination
- AllOfListSecretResponseLinks
- AllOfListSecretResponsePagination
- AllOfListSnapshotResponseLinks
- AllOfListSnapshotResponsePagination
- AllOfListSnapshotsAuditResponseLinks
- AllOfListSnapshotsAuditResponsePagination
- AllOfListTagAuditsResponseLinks
- AllOfListTagAuditsResponsePagination
- AllOfListTagResponseLinks
- AllOfListTagResponsePagination
- AllOfListUserAuditResponseLinks
- AllOfListUserAuditResponsePagination
- AllOfListUserResponseLinks
- AllOfListUserResponsePagination
- AllOfObjectStorageResponseAutoScaling
- AllOfObjectStoragesStatsResponseLinks
- AllOfPatchInstanceResponseLinks
- AllOfPatchPrivateNetworkResponseLinks
- AllOfReinstallInstanceResponseLinks
- AllOfRollbackSnapshotResponseLinks
- AllOfUnassignInstancePrivateNetworkResponseLinks
- AllOfUpdateCustomImageResponseLinks
- AllOfUpdateRoleResponseLinks
- AllOfUpdateSecretResponseLinks
- AllOfUpdateSnapshotResponseLinks
- AllOfUpdateTagResponseLinks
- AllOfUpdateUserResponseLinks
- AllOfUpgradeInstanceRequestPrivateNetworking
- AllOfUpgradeObjectStorageRequestAutoScaling
- AllOfUpgradeObjectStorageResponseDataAutoScaling
- AllOfUpgradeObjectStorageResponseLinks
- ApiPermissionsResponse
- AssignInstancePrivateNetworkResponse
- AssignmentAuditResponse
- AssignmentResponse
- AutoScalingTypeRequest
- AutoScalingTypeResponse
- CancelInstanceResponse
- CancelInstanceResponseData
- CancelObjectStorageResponse
- CancelObjectStorageResponseData
- ClientResponse
- ClientSecretResponse
- CreateAssignmentResponse
- CreateCustomImageFailResponse
- CreateCustomImageRequest
- CreateCustomImageResponse
- CreateCustomImageResponseData
- CreateInstanceAddons
- CreateInstanceRequest
- CreateInstanceResponse
- CreateInstanceResponseData
- CreateObjectStorageRequest
- CreateObjectStorageResponse
- CreateObjectStorageResponseData
- CreatePrivateNetworkRequest
- CreatePrivateNetworkResponse
- CreateRoleRequest
- CreateRoleResponse
- CreateRoleResponseData
- CreateSecretRequest
- CreateSecretResponse
- CreateSnapshotRequest
- CreateSnapshotResponse
- CreateTagRequest
- CreateTagResponse
- CreateTagResponseData
- CreateTicketRequest
- CreateTicketResponse
- CreateTicketResponseData
- CreateUserRequest
- CreateUserResponse
- CreateUserResponseData
- CredentialData
- CustomImagesStatsResponse
- CustomImagesStatsResponseData
- DataCenterResponse
- ExtraStorageRequest
- FindAssignmentResponse
- FindClientResponse
- FindCredentialResponse
- FindImageResponse
- FindInstanceResponse
- FindObjectStorageResponse
- FindPrivateNetworkResponse
- FindRoleResponse
- FindSecretResponse
- FindSnapshotResponse
- FindTagResponse
- FindUserIsPasswordSetResponse
- FindUserResponse
- FindVncResponse
- FirewallingUpgradeRequest
- GenerateClientSecretResponse
- ImageAuditResponse
- ImageAuditResponseData
- ImageResponse
- InstanceAssignmentSelfLinks
- InstanceRescueActionResponse
- InstanceRescueActionResponseData
- InstanceResetPasswordActionResponse
- InstanceResetPasswordActionResponseData
- InstanceResponse
- InstanceRestartActionResponse
- InstanceRestartActionResponseData
- InstanceShutdownActionResponse
- InstanceShutdownActionResponseData
- InstanceStartActionResponse
- InstanceStartActionResponseData
- InstanceStatus
- InstanceStopActionResponse
- InstanceStopActionResponseData
- Instances
- InstancesActionsAuditResponse
- InstancesActionsRescueRequest
- InstancesAuditResponse
- InstancesResetPasswordActionsRequest
- IpConfig
- IpV4
- IpV6
- Links
- ListApiPermissionResponse
- ListAssignmentAuditsResponse
- ListAssignmentResponse
- ListCredentialResponse
- ListDataCenterResponse
- ListImageResponse
- ListImageResponseData
- ListInstancesActionsAuditResponse
- ListInstancesAuditResponse
- ListInstancesResponse
- ListInstancesResponseData
- ListObjectStorageAuditResponse
- ListObjectStorageResponse
- ListPrivateNetworkAuditResponse
- ListPrivateNetworkResponse
- ListPrivateNetworkResponseData
- ListRoleAuditResponse
- ListRoleResponse
- ListSecretAuditResponse
- ListSecretResponse
- ListSnapshotResponse
- ListSnapshotsAuditResponse
- ListTagAuditsResponse
- ListTagResponse
- ListUserAuditResponse
- ListUserResponse
- ObjectStorageAuditResponse
- ObjectStorageResponse
- ObjectStoragesStatsResponse
- ObjectStoragesStatsResponseData
- PaginationMeta
- PatchInstanceRequest
- PatchInstanceResponse
- PatchInstanceResponseData
- PatchObjectStorageRequest
- PatchPrivateNetworkRequest
- PatchPrivateNetworkResponse
- PatchVncRequest
- PermissionRequest
- PermissionResponse
- PrivateIpConfig
- PrivateNetworkAuditResponse
- PrivateNetworkResponse
- PrivateNetworkingUpgradeRequest
- ReinstallInstanceRequest
- ReinstallInstanceResponse
- ReinstallInstanceResponseData
- ResourcePermissionsResponse
- RoleAuditResponse
- RoleResponse
- RollbackSnapshotRequest
- RollbackSnapshotResponse
- SecretAuditResponse
- SecretResponse
- SelfLinks
- SnapshotResponse
- SnapshotsAuditResponse
- TagAssignmentSelfLinks
- TagAuditResponse
- TagResponse
- TagResponse1
- UnassignInstancePrivateNetworkResponse
- UpdateCustomImageRequest
- UpdateCustomImageResponse
- UpdateCustomImageResponseData
- UpdateRoleRequest
- UpdateRoleResponse
- UpdateSecretRequest
- UpdateSecretResponse
- UpdateSnapshotRequest
- UpdateSnapshotResponse
- UpdateTagRequest
- UpdateTagResponse
- UpdateUserRequest
- UpdateUserResponse
- UpgradeAutoScalingType
- UpgradeInstanceRequest
- UpgradeObjectStorageRequest
- UpgradeObjectStorageResponse
- UpgradeObjectStorageResponseData
- UserAuditResponse
- UserIsPasswordSetResponse
- UserResponse
- VncResponse
Documentation For Authorization
bearer
- Type: HTTP bearer authentication
Author
All versions of contabo-sdk with dependencies
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0