Commands
Documentation for `scw partner`
The CLI documentation pages are currently under construction
The content is up to date. We're making improvements to the site over the next few weeks for a better experience.
Scaleway Partner API ( for partner only ).
Organization management commands
Organization management commands.
Create a new organization
Create a new organization.
Usage:
Code
Args:
| Name | Description | |
|---|---|---|
| partner-id | Required | Your personal partner_id. This is the same as your Organization ID. |
| Required | The email of the new organization owner | |
| organization-name | Required | The name of the organization you want to create. Usually the company name |
| owner-firstname | Required | The first name of the new organization owner |
| owner-lastname | Required | The last name of the new organization owner |
| phone-number | The phone number of the new organization owner | |
| customer-id | Required | A custom ID for the customer in your own infrastructure |
| siren-number | A SIREN number for the customer |
Get an organization
Get an organization.
Usage:
Code
Args:
| Name | Description | |
|---|---|---|
| organization-id | Organization ID to use. If none is passed the default organization ID will be used |
List Organizations
List Organizations.
Usage:
Code
Args:
| Name | Description | |
|---|---|---|
| order-by | One of: created_at_asc, created_at_desc | |
| status | One of: unknown_status, opened, locked, closed | Only list organizations with this status |
| Only list organizations created with this email | ||
| customer-id | Only list organizations attached to this Customer ID | |
| locked-by | One of: unknown_locked_by, partner, scaleway | Only list organizations locked by a certain entity |
Lock an organization
Lock an organization.
Usage:
Code
Args:
| Name | Description | |
|---|---|---|
| organization-id | Organization ID to use. If none is passed the default organization ID will be used |
Unlock an organization
Unlock an organization.
Usage:
Code
Args:
| Name | Description | |
|---|---|---|
| organization-id | Organization ID to use. If none is passed the default organization ID will be used |
Update an organization
Update an organization.
Usage:
Code
Args:
| Name | Description | |
|---|---|---|
| The new email | ||
| name | The new name | |
| owner-firstname | The first name of the new owner | |
| owner-lastname | The last name of the new owner | |
| phone-number | The phone number of the new owner | |
| customer-id | Customer ID associated with this organization | |
| comment | A comment about the organization | |
| organization-id | Organization ID to use. If none is passed the default organization ID will be used |