Introduction
The resource controller is the next-generation IBM Cloud platform provisioning layer that manages the lifecycle of IBM Cloud resources in a customer account. Resources is a broad term that could mean anything from an instance of a service like Cloudant, a Cloud Foundry application, a virtual machine, a container, a software image, a data set, or other entities associated to the customer account.
The resource controller provides common APIs to control the lifecycle of resources from provisioning (creating an instance) to binding (creating access credentials) to unbinding (removing access) to de-provisioning (deleting an instance). Resources are provisioned globally in an account scope. The resource controller supports both synchronous and asynchronous provisioning of resources.
Resources are created by the resource controller within resource groups. A resource group belongs to an account. All IBM Cloud resources must be provisioned within a resource group. If an account is suspended, the corresponding resource group are suspended as well, and all resources within the resource group are suspended.
Resource instances
When the resource controller provisions or creates and instance, provisioning reserves a resource on a service; we call this reserved resource a resource instance (service instance). What a resource instance represents can vary by service. Examples include a single database on a multi-tenant server, a dedicated cluster, or an account on a web application.
Resource bindings and keys
A resource binding is the representation of an association between an application and a resource (service) instance. Often, resource bindings will contain the credentials (keys) that the application will use to communicate with the resource instance. Keys are credentials used to connect (bind) a service to another application.
Resource aliases
You can think of an alias as a symlink in computing terms. It represents an entity that points back to a resource instance and enables you to define different access controls on it. As with symlinks you can also create multiple aliases to a single resource instance and manage each one separately.
For example, you can create an instance of a service and then reuse that instance in both London and Dallas by creating aliases in both regions. This enables you to bind keys (credentials) to applications that run in those regions and utilize the same logical instance.
API endpoint
https://resource-controller.cloud.ibm.com/v2/
Error handling
This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response indicates success. A 400 type response indicates a failure, and a 500 type response indicates an internal system error.
Additionally, each response includes a Transaction-Id header which can be referenced when contacting IBM Cloud support.
| HTTP Error Code | Description | Recovery |
|---|---|---|
200 |
Success | The request was successful. |
400 |
Bad Request | The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request. |
401 |
Unauthorized | You are not authorized to make this request. Log in to IBM Cloud and try again. If this error persists, contact the account owner to check your permissions. |
403 |
Forbidden | The supplied authentication is not authorized to access '{namespace}'. |
404 |
Not Found | The requested resource could not be found. |
409 |
Conflict | The entity is already in the requested state. |
410 |
Gone | The resource is valid but has been removed already in a previous call |
500 |
Internal Server Error | The service is currently unavailable. Your request could not be processed. Wait a few minutes and try again. |
Authentication
To work with the API, authenticate your app or service by including your IBM Cloud IAM access token in the API request authentication header:
-H 'Authorization: Bearer <IAM_TOKEN>'
You can retrieve an access token by first creating an API key, and then exchanging your API key for a IBM Cloud IAM token. For more information, see Getting an IBM Cloud IAM token by using an API key.
To retrieve your access token:
curl -X POST
https://iam.cloud.ibm.com/identity/token
-H "Content-Type: application/x-www-form-urlencoded"
-H "Accept: application/json"
-d "grant_type=urn%3Aibm%3Aparams%3Aoauth%3Agrant-type%3Aapikey&apikey=<API_KEY>"
Replace <API_KEY> with your service credentials. Then use the full IAM token value, prefixed by the Bearer token type, to authenticate your API requests.
To retrieve your instance ID:
ibmcloud resource service-instance <instance_name> --id
Replace <instance_name> with the unique alias that you assigned to your service instance.
Pagination
Some API requests might return a large number of results. To avoid performance issues, these results are returned one page at a time, with a limited number of results on each page. GET requests for the following resources use pagination:
- /v2/resource_instances
- /v2/resource_bindings
- /v2/resource_keys
- /v2/resource_aliases
The default page and max size is 100 objects. To use a different page size, use the limit query parameter.
For any request that uses pagination, the response includes a next_url object that specifies pagination information. next_url is the URL for requesting the next page of results. The next_url property is null if there are no more results, and retains the same limit parameter that is used for the initial request.
Rate limiting
Rate limits for API requests are enforced on a per-caller basis. If the number of requests for a particular method and endpoint reaches the request limit within the specified time window, no further requests are accepted until the timer expires. After the timer expires, a new time window begins with the next accepted request.
The response to each HTTP request includes headers you can use to determine whether you are close to the rate limit:
- X-RateLimit-Reset: the time the current timer expires (in UNIX epoch time)
- X-RateLimit-Remaining: the number of requests remaining in the current time window
- X-RateLimit-Limit: the total number of requests allowed within the time window
An HTTP status code of 429 indicates that the rate limit has been exceeded.
The number of allowed requests, and the length of the time window, vary by method and endpoint. The reference information for each endpoint specifies the rate limit that applies.
Methods
Query Parameters
When you provision a new resource in the specified location for the selected plan, a GUID (globally unique identifier) is created. This is a unique internal GUID managed by Resource controller that corresponds to the instance.
The human-readable name of the instance.
Short ID of a resource group.
The unique ID of the offering. This value is provided by and stored in the global catalog.
The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
The type of the instance. For example,
service_instance.The sub-type of instance, e.g.
cfaas.Limit on how many items should be returned.
Start date inclusive filter.
Example:
2019-01-08T00:00:00.000ZEnd date inclusive filter.
Example:
2019-01-08T00:00:00.000Z
curl -X GET \ https://resource-controller.cloud.ibm.com/v2/resource_instances \ -H 'Authorization: Bearer <>' \
A list of resource instances.
The URL for requesting the next page of results.
A list of resource instances.
The number of resource instances in
resources.
Status Code
The list of resource instances was successfully retrieved.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
{ "rows_count": 1, "next_url": "/v2/resource_instances?next_docid=g1AAAACkeJzLYWBgYMpgTmFQSklKzi9KdUhJMtTLTMrVTSouNjAw1EvOyS9NScwr0ctLLckBqc1jAZIMC4DU____92eBxdycyiQ6O2sOMCQxMLHnZKEaZ0qEcQ8gxv2HG-fo9M_-Asg4-TVZWQCZcDI1&limit=2&account_id=d86af7367f70fba4f306d3c19c7344b2", "resources": [ { "id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "guid": "8d7af921-b136-4078-9666-081bd8470d94", "url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94", "created_at": "2018-04-19T00:18:53.302077457Z", "updated_at": "2018-04-19T00:18:53.302077457Z", "deleted_at": null, "name": "my-instance", "region_id": "global", "account_id": "4329073d16d2f3663f74bfa955259139", "resource_plan_id": "2fdf0c08-2d32-4f46-84b5-32e0c92fffd8", "resource_group_id": "0be5ad401ae913d8ff665d92680664ed", "resource_group_crn": "crn:v1:bluemix:public:resource-controller::a/4329073d16d2f3663f74bfa955259139::resource-group:0be5ad401ae913d8ff665d92680664ed", "target_crn": "crn:v1:bluemix:public:resource-catalog::a/9e16d1fed8aa7e1bd73e7a9d23434a5a::deployment:2fdf0c08-2d32-4f46-84b5-32e0c92fffd8%3Aglobal", "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "state": "active", "type": "service_instance", "resource_id": "dff97f5c-bc5e-4455-b470-411c3edbe49c", "dashboard_url": "/objectstorage/crn%3Av1%3Abluemix%3Apublic%3Acloud-object-storage%3Aglobal%3Aa%2F4329073d16d2f3663f74bfa955259139%3A8d7af921-b136-4078-9666-081bd8470d94%3A%3A", "last_operation": null, "resource_aliases_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94/resource_aliases", "resource_bindings_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94/resource_bindings", "resource_keys_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94/resource_keys", "plan_history": [ { "resource_plan_id": "2fdf0c08-2d32-4f46-84b5-32e0c92fffd8", "start_date": "2018-04-19T00:18:53.302077457Z" } ], "migrated": false, "controlled_by": "" } ] }
Create (provision) a new resource instance
Provision a new resource in the specified location for the selected plan.
POST /resource_instancesProperty values for the new resource instance.
The name of the instance. Must be 180 characters or less and cannot include any special characters other than
(space) - . _ :.Constraints: Value must match regular expression
^([^[:ascii:]]|[a-zA-Z0-9-._: ])+$Example:
my-instanceThe deployment location where the instance should be hosted.
Example:
bluemix-us-southShort or long ID of resource group
Example:
5c49eabc-f5e8-5881-a37e-2d100a33b3dfThe unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
Example:
cloudant-standardTags that are attached to the instance after provisioning. These tags can be searched and managed through the Tagging API in IBM Cloud.
Configuration options represented as key-value pairs that are passed through to the target resource brokers.
curl -X POST \ https://resource-controller.cloud.ibm.com/v2/resource_instances \ -H 'Authorization: Bearer <>' \ -H 'Content-Type: application/json' \ -d '{ "name": "my-instance", "target": "bluemix-global", "resource_group": "5g9f447903254bb58972a2f3f5a4c711", "resource_plan_id": "0be5ad401ae913d8ff665d92680664ed", "tags": [ "my-tag" ] }'
A resource instance.
The ID associated with the instance.
When you create a new resource, a globally unique identifier (GUID) is assigned. This GUID is a unique internal identifier managed by the resource controller that corresponds to the instance.
The full Cloud Resource Name (CRN) associated with the instance. For more information about this format, see Cloud Resource Names.
When you provision a new resource, a relative URL path is created identifying the location of the instance.
The human-readable name of the instance.
An alpha-numeric value identifying the account ID.
The short ID of the resource group.
The long ID (full CRN) of the resource group.
The unique ID of the offering. This value is provided by and stored in the global catalog.
The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
The full deployment CRN as defined in the global catalog. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned.
The current state of the instance. For example, if the instance is deleted, it will return removed.
The type of the instance, e.g.
service_instance.The sub-type of instance, e.g.
cfaas.The status of the last operation requested on the instance.
The resource-broker-provided URL to access administrative features of the instance.
The plan history of the instance.
The relative path to the resource aliases for the instance.
The relative path to the resource bindings for the instance.
The relative path to the resource keys for the instance.
The date when the instance was created.
The date when the instance was last updated.
The date when the instance was deleted.
Status Code
The resource instance was provisioned.
Request to provision a resource has been accepted.
The request could not be understood due to malformed syntax.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
The resource could not be found.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
{ "id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "guid": "8d7af921-b136-4078-9666-081bd8470d94", "url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94", "created_at": "2018-04-19T00:18:53.302077457Z", "updated_at": "2018-04-19T00:18:53.302077457Z", "deleted_at": null, "name": "my-instance", "region_id": "global", "account_id": "4329073d16d2f3663f74bfa955259139", "resource_plan_id": "2fdf0c08-2d32-4f46-84b5-32e0c92fffd8", "resource_group_id": "0be5ad401ae913d8ff665d92680664ed", "resource_group_crn": "crn:v1:bluemix:public:resource-controller::a/4329073d16d2f3663f74bfa955259139::resource-group:0be5ad401ae913d8ff665d92680664ed", "target_crn": "crn:v1:bluemix:public:resource-catalog::a/9e16d1fed8aa7e1bd73e7a9d23434a5a::deployment:2fdf0c08-2d32-4f46-84b5-32e0c92fffd8%3Aglobal", "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "state": "active", "type": "service_instance", "resource_id": "dff97f5c-bc5e-4455-b470-411c3edbe49c", "dashboard_url": "/objectstorage/crn%3Av1%3Abluemix%3Apublic%3Acloud-object-storage%3Aglobal%3Aa%2F4329073d16d2f3663f74bfa955259139%3A8d7af921-b136-4078-9666-081bd8470d94%3A%3A", "last_operation": null, "resource_aliases_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94/resource_aliases", "resource_bindings_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94/resource_bindings", "resource_keys_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94/resource_keys", "plan_history": [ { "resource_plan_id": "2fdf0c08-2d32-4f46-84b5-32e0c92fffd8", "start_date": "2018-04-19T00:18:53.302077457Z" } ], "migrated": false, "controlled_by": "" }
Path Parameters
The short or long ID of the instance.
curl -X GET \ https://resource-controller.cloud.ibm.com/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94 \ -H 'Authorization: Bearer <>' \
A resource instance.
The ID associated with the instance.
When you create a new resource, a globally unique identifier (GUID) is assigned. This GUID is a unique internal identifier managed by the resource controller that corresponds to the instance.
The full Cloud Resource Name (CRN) associated with the instance. For more information about this format, see Cloud Resource Names.
When you provision a new resource, a relative URL path is created identifying the location of the instance.
The human-readable name of the instance.
An alpha-numeric value identifying the account ID.
The short ID of the resource group.
The long ID (full CRN) of the resource group.
The unique ID of the offering. This value is provided by and stored in the global catalog.
The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
The full deployment CRN as defined in the global catalog. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned.
The current state of the instance. For example, if the instance is deleted, it will return removed.
The type of the instance, e.g.
service_instance.The sub-type of instance, e.g.
cfaas.The status of the last operation requested on the instance.
The resource-broker-provided URL to access administrative features of the instance.
The plan history of the instance.
The relative path to the resource aliases for the instance.
The relative path to the resource bindings for the instance.
The relative path to the resource keys for the instance.
The date when the instance was created.
The date when the instance was last updated.
The date when the instance was deleted.
Status Code
The resource instance was successfully retrieved.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
The resource could not be found.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
{ "id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "guid": "8d7af921-b136-4078-9666-081bd8470d94", "url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94", "created_at": "2018-04-19T00:18:53.302077457Z", "updated_at": "2018-04-19T00:18:53.302077457Z", "deleted_at": null, "name": "my-instance", "region_id": "global", "account_id": "4329073d16d2f3663f74bfa955259139", "resource_plan_id": "2fdf0c08-2d32-4f46-84b5-32e0c92fffd8", "resource_group_id": "0be5ad401ae913d8ff665d92680664ed", "resource_group_crn": "crn:v1:bluemix:public:resource-controller::a/4329073d16d2f3663f74bfa955259139::resource-group:0be5ad401ae913d8ff665d92680664ed", "target_crn": "crn:v1:bluemix:public:resource-catalog::a/9e16d1fed8aa7e1bd73e7a9d23434a5a::deployment:2fdf0c08-2d32-4f46-84b5-32e0c92fffd8%3Aglobal", "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "state": "active", "type": "service_instance", "resource_id": "dff97f5c-bc5e-4455-b470-411c3edbe49c", "dashboard_url": "/objectstorage/crn%3Av1%3Abluemix%3Apublic%3Acloud-object-storage%3Aglobal%3Aa%2F4329073d16d2f3663f74bfa955259139%3A8d7af921-b136-4078-9666-081bd8470d94%3A%3A", "last_operation": null, "resource_aliases_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94/resource_aliases", "resource_bindings_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94/resource_bindings", "resource_keys_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94/resource_keys", "plan_history": [ { "resource_plan_id": "2fdf0c08-2d32-4f46-84b5-32e0c92fffd8", "start_date": "2018-04-19T00:18:53.302077457Z" } ], "migrated": false, "controlled_by": "" }
Path Parameters
The short or long ID of the instance.
curl -X DELETE \ https://resource-controller.cloud.ibm.com/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94 \ -H 'Authorization: Bearer <>' \
A resource instance.
The ID associated with the instance.
When you create a new resource, a globally unique identifier (GUID) is assigned. This GUID is a unique internal identifier managed by the resource controller that corresponds to the instance.
The full Cloud Resource Name (CRN) associated with the instance. For more information about this format, see Cloud Resource Names.
When you provision a new resource, a relative URL path is created identifying the location of the instance.
The human-readable name of the instance.
An alpha-numeric value identifying the account ID.
The short ID of the resource group.
The long ID (full CRN) of the resource group.
The unique ID of the offering. This value is provided by and stored in the global catalog.
The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
The full deployment CRN as defined in the global catalog. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned.
The current state of the instance. For example, if the instance is deleted, it will return removed.
The type of the instance, e.g.
service_instance.The sub-type of instance, e.g.
cfaas.The status of the last operation requested on the instance.
The resource-broker-provided URL to access administrative features of the instance.
The plan history of the instance.
The relative path to the resource aliases for the instance.
The relative path to the resource bindings for the instance.
The relative path to the resource keys for the instance.
The date when the instance was created.
The date when the instance was last updated.
The date when the instance was deleted.
Status Code
Accepted
Deleted
The request could not be understood due to malformed syntax.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
The resource could not be found.
The resource could was previously deleted and is no longer available.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
No Sample Response
Path Parameters
The short or long ID of the instance.
Updated property values for a resource instance.
The new name of the instance. Must be 180 characters or less and cannot include any special characters other than
(space) - . _ :.Constraints: Value must match regular expression
^([^[:ascii:]]|[a-zA-Z0-9-._: ])+$Example:
my-new-instance-nameThe new configuration options for the instance.
The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
Example:
a8dff6d3-d287-4668-a81d-c87c55c2656d
curl -X PATCH \ https://resource-controller.cloud.ibm.com/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94 \ -H 'Authorization: Bearer <>' \ -H 'Content-Type: application/json' \ -d '{ "name": "my-instance-new-binding-1", "resource_plan_id": "744bfc56-d12c-4866-88d5-dac9139e0e5d" }'
A resource instance.
The ID associated with the instance.
When you create a new resource, a globally unique identifier (GUID) is assigned. This GUID is a unique internal identifier managed by the resource controller that corresponds to the instance.
The full Cloud Resource Name (CRN) associated with the instance. For more information about this format, see Cloud Resource Names.
When you provision a new resource, a relative URL path is created identifying the location of the instance.
The human-readable name of the instance.
An alpha-numeric value identifying the account ID.
The short ID of the resource group.
The long ID (full CRN) of the resource group.
The unique ID of the offering. This value is provided by and stored in the global catalog.
The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
The full deployment CRN as defined in the global catalog. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned.
The current state of the instance. For example, if the instance is deleted, it will return removed.
The type of the instance, e.g.
service_instance.The sub-type of instance, e.g.
cfaas.The status of the last operation requested on the instance.
The resource-broker-provided URL to access administrative features of the instance.
The plan history of the instance.
The relative path to the resource aliases for the instance.
The relative path to the resource bindings for the instance.
The relative path to the resource keys for the instance.
The date when the instance was created.
The date when the instance was last updated.
The date when the instance was deleted.
Status Code
The requested changes have been applied
Request to update a resource instance has been accepted
The request could not be understood due to malformed syntax.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
The resource could not be found.
The request could not be processed.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
{ "id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "guid": "8d7af921-b136-4078-9666-081bd8470d94", "url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94", "created_at": "2018-04-19T00:18:53.302077457Z", "updated_at": "2018-04-19T00:18:53.302077457Z", "deleted_at": null, "name": "my-instance", "region_id": "global", "account_id": "4329073d16d2f3663f74bfa955259139", "resource_plan_id": "744bfc56-d12c-4866-88d5-dac9139e0e5d", "resource_group_id": "0be5ad401ae913d8ff665d92680664ed", "resource_group_crn": "crn:v1:bluemix:public:resource-controller::a/4329073d16d2f3663f74bfa955259139::resource-group:0be5ad401ae913d8ff665d92680664ed", "target_crn": "crn:v1:bluemix:public:resource-catalog::a/9e16d1fed8aa7e1bd73e7a9d23434a5a::deployment:2fdf0c08-2d32-4f46-84b5-32e0c92fffd8%3Aglobal", "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "state": "active", "type": "service_instance", "resource_id": "dff97f5c-bc5e-4455-b470-411c3edbe49c", "dashboard_url": "/objectstorage/crn%3Av1%3Abluemix%3Apublic%3Acloud-object-storage%3Aglobal%3Aa%2F4329073d16d2f3663f74bfa955259139%3A8d7af921-b136-4078-9666-081bd8470d94%3A%3A", "last_operation": null, "resource_aliases_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94/resource_aliases", "resource_bindings_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94/resource_bindings", "resource_keys_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94/resource_keys", "plan_history": [ { "resource_plan_id": "2fdf0c08-2d32-4f46-84b5-32e0c92fffd8", "start_date": "2018-04-19T00:18:53.302077457Z" } ], "migrated": false, "controlled_by": "" }
Query Parameters
When you create a new key, a GUID (globally unique identifier) is assigned. This is a unique internal GUID managed by Resource controller that corresponds to the key.
The human-readable name of the key.
The short ID of the resource group.
The unique ID of the offering. This value is provided by and stored in the global catalog.
Limit on how many items should be returned.
Start date inclusive filter.
Example:
2019-01-08T00:00:00.000ZEnd date inclusive filter.
Example:
2019-01-08T00:00:00.000Z
curl -X GET \ https://resource-controller.cloud.ibm.com/v2/resource_keys \ -H 'Authorization: Bearer <IAM_TOKEN>' \
A list of resource keys.
The URL for requesting the next page of results.
A list of resource keys.
The number of resource keys in
resources.
Status Code
The list of resource keys was successfully retrieved.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
{ "rows_count": 1, "next_url": null, "resources": [ { "id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-key:23693f48-aaa2-4079-b0c7-334846eff8d0", "guid": "23693f48-aaa2-4079-b0c7-334846eff8d0", "url": "/v2/resource_keys/23693f48-aaa2-4079-b0c7-334846eff8d0", "created_at": "2018-07-02T22:03:43.837979455Z", "updated_at": "2018-07-02T22:03:43.837979455Z", "deleted_at": null, "source_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "name": "my-instance-key-1", "parameters": { "role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer" }, "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-key:23693f48-aaa2-4079-b0c7-334846eff8d0", "state": "active", "account_id": "4329073d16d2f3663f74bfa955259139", "resource_group_id": "0be5ad401ae913d8ff665d92680664ed", "resource_id": "dff97f5c-bc5e-4455-b470-411c3edbe49c", "credentials": { "apikey": "XXXX-YYYY-ZZZZ\"", "endpoints": "https://cos-service-armada-s.us-south.containers.mybluemix.net/endpoints", "iam_apikey_description": "Auto generated apikey during resource-key operation for Instance - crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "iam_apikey_name": "auto-generated-apikey-23693f48-aaa2-4079-b0c7-334846eff8d0", "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer", "iam_serviceid_crn": "crn:v1:bluemix:public:iam-identity::a/4329073d16d2f3663f74bfa955259139::serviceid:ServiceId-64c29e4f-422d-468c-a11b-1a8f671b5c89", "resource_instance_id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::" }, "iam_compatible": true, "migrated": false, "resource_instance_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94", "resource_alias_url": null } ] }
Property values for the new resource key.
The name of the key.
Example:
my-keyThe short or long ID of resource instance or alias.
Example:
25eba2a9-beef-450b-82cf-f5ad5e36c6ddConfiguration options represented as key-value pairs. Service defined options are passed through to the target resource brokers, platform defined options are not.
An optional platform defined option to reuse an existing IAM serviceId for the role assignment.
Example:
crn:v1:bluemix:public:iam-identity::a/9fceaa56d1ab84893af6b9eec5ab81bb::serviceid:ServiceId-fe4c29b5-db13-410a-bacc-b5779a03d393
parameters
The role name or it's CRN.
Default:
WriterExample:
Writer
curl -X POST \ https://resource-controller.cloud.ibm.com/v2/resource_keys \ -H 'Authorization: Bearer <IAM_TOKEN>' \ -H 'Content-Type: application/json' \ -d '{ "name": "my-instance-key-1", "source": "267bf377-7fa2-43f6-94ec-09103a8e89d4", "role": "Writer" }'
A resource key.
The ID associated with the key.
When you create a new key, a globally unique identifier (GUID) is assigned. This GUID is a unique internal identifier managed by the resource controller that corresponds to the key.
The full Cloud Resource Name (CRN) associated with the key. For more information about this format, see Cloud Resource Names.
When you created a new key, a relative URL path is created identifying the location of the key.
The human-readable name of the key.
An alpha-numeric value identifying the account ID.
The short ID of the resource group.
The CRN of resource instance or alias associated to the key.
The state of the key.
The credentials for the key. Additional key-value pairs are passed through from the resource brokers. Refer to service’s documentation for additional details.
The API key for the credentials.
The optional description of the API key.
The name of the API key.
The Cloud Resource Name for the role of the credentials.
The Cloud Resource Name for the service ID of the credentials.
Additional key-value pairs from the resource broker.
credentials
Specifies whether the key’s credentials support IAM.
The relative path to the resource.
The date when the key was created.
The date when the key was last updated.
The date when the key was deleted.
Status Code
Created
The request could not be understood due to malformed syntax.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
The resource could not be found.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
{ "id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-key:23693f48-aaa2-4079-b0c7-334846eff8d0", "guid": "23693f48-aaa2-4079-b0c7-334846eff8d0", "url": "/v2/resource_keys/23693f48-aaa2-4079-b0c7-334846eff8d0", "created_at": "2018-07-02T22:03:43.837979455Z", "updated_at": "2018-07-02T22:03:43.837979455Z", "deleted_at": null, "source_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "name": "my-instance-key-1", "parameters": { "role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer" }, "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-key:23693f48-aaa2-4079-b0c7-334846eff8d0", "state": "active", "account_id": "4329073d16d2f3663f74bfa955259139", "resource_group_id": "0be5ad401ae913d8ff665d92680664ed", "resource_id": "dff97f5c-bc5e-4455-b470-411c3edbe49c", "credentials": { "apikey": "XXXX-YYYY-ZZZZ\"", "endpoints": "https://cos-service-armada-s.us-south.containers.mybluemix.net/endpoints", "iam_apikey_description": "Auto generated apikey during resource-key operation for Instance - crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "iam_apikey_name": "auto-generated-apikey-23693f48-aaa2-4079-b0c7-334846eff8d0", "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer", "iam_serviceid_crn": "crn:v1:bluemix:public:iam-identity::a/4329073d16d2f3663f74bfa955259139::serviceid:ServiceId-64c29e4f-422d-468c-a11b-1a8f671b5c89", "resource_instance_id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::" }, "iam_compatible": true, "migrated": false, "resource_instance_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94", "resource_alias_url": null }
Path Parameters
The short or long ID of the key.
curl -X GET \ https://resource-controller.cloud.ibm.com/v2/resource_keys/23693f48-aaa2-4079-b0c7-334846eff8d0 \ -H 'Authorization: Bearer <IAM_TOKEN>' \
A resource key.
The ID associated with the key.
When you create a new key, a globally unique identifier (GUID) is assigned. This GUID is a unique internal identifier managed by the resource controller that corresponds to the key.
The full Cloud Resource Name (CRN) associated with the key. For more information about this format, see Cloud Resource Names.
When you created a new key, a relative URL path is created identifying the location of the key.
The human-readable name of the key.
An alpha-numeric value identifying the account ID.
The short ID of the resource group.
The CRN of resource instance or alias associated to the key.
The state of the key.
The credentials for the key. Additional key-value pairs are passed through from the resource brokers. Refer to service’s documentation for additional details.
The API key for the credentials.
The optional description of the API key.
The name of the API key.
The Cloud Resource Name for the role of the credentials.
The Cloud Resource Name for the service ID of the credentials.
Additional key-value pairs from the resource broker.
credentials
Specifies whether the key’s credentials support IAM.
The relative path to the resource.
The date when the key was created.
The date when the key was last updated.
The date when the key was deleted.
Status Code
The resource key was successfully retrieved.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
The resource could not be found.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
{ "id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-key:23693f48-aaa2-4079-b0c7-334846eff8d0", "guid": "23693f48-aaa2-4079-b0c7-334846eff8d0", "url": "/v2/resource_keys/23693f48-aaa2-4079-b0c7-334846eff8d0", "created_at": "2018-07-02T22:03:43.837979455Z", "updated_at": "2018-07-02T22:03:43.837979455Z", "deleted_at": null, "source_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "name": "my-instance-key-1", "parameters": { "role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer" }, "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-key:23693f48-aaa2-4079-b0c7-334846eff8d0", "state": "active", "account_id": "4329073d16d2f3663f74bfa955259139", "resource_group_id": "0be5ad401ae913d8ff665d92680664ed", "resource_id": "dff97f5c-bc5e-4455-b470-411c3edbe49c", "credentials": { "apikey": "XXXX-YYYY-ZZZZ", "endpoints": "https://cos-service-armada-s.us-south.containers.mybluemix.net/endpoints", "iam_apikey_description": "Auto generated apikey during resource-key operation for Instance - crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "iam_apikey_name": "auto-generated-apikey-23693f48-aaa2-4079-b0c7-334846eff8d0", "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer", "iam_serviceid_crn": "crn:v1:bluemix:public:iam-identity::a/4329073d16d2f3663f74bfa955259139::serviceid:ServiceId-64c29e4f-422d-468c-a11b-1a8f671b5c89", "resource_instance_id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::" }, "iam_compatible": true, "migrated": false, "resource_instance_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94", "resource_alias_url": null }
Path Parameters
The short or long ID of the key.
curl -X DELETE \ https://resource-controller.cloud.ibm.com/v2/resource_keys/23693f48-aaa2-4079-b0c7-334846eff8d0 \ -H 'Authorization: Bearer <IAM_TOKEN>' \
Status Code
Deleted
The request could not be understood due to malformed syntax.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
The resource could not be found.
The resource could was previously deleted and is no longer available.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
No Sample Response
Path Parameters
The short or long ID of the key.
Updated property values for the resource key.
The new name of the key. Must be 180 characters or less and cannot include any special characters other than
(space) - . _ :.Constraints: Value must match regular expression
^([^[:ascii:]]|[a-zA-Z0-9-._: ])+$Example:
my-new-key-name
curl -X PATCH \ https://resource-controller.cloud.ibm.com/v2/resource_keys/23693f48-aaa2-4079-b0c7-334846eff8d0 \ -H 'Authorization: Bearer <IAM_TOKEN>' \ -H 'Content-Type: application/json' \ -d '{ "name": "my-instance-new-key-1", }'
A resource key.
The ID associated with the key.
When you create a new key, a globally unique identifier (GUID) is assigned. This GUID is a unique internal identifier managed by the resource controller that corresponds to the key.
The full Cloud Resource Name (CRN) associated with the key. For more information about this format, see Cloud Resource Names.
When you created a new key, a relative URL path is created identifying the location of the key.
The human-readable name of the key.
An alpha-numeric value identifying the account ID.
The short ID of the resource group.
The CRN of resource instance or alias associated to the key.
The state of the key.
The credentials for the key. Additional key-value pairs are passed through from the resource brokers. Refer to service’s documentation for additional details.
The API key for the credentials.
The optional description of the API key.
The name of the API key.
The Cloud Resource Name for the role of the credentials.
The Cloud Resource Name for the service ID of the credentials.
Additional key-value pairs from the resource broker.
credentials
Specifies whether the key’s credentials support IAM.
The relative path to the resource.
The date when the key was created.
The date when the key was last updated.
The date when the key was deleted.
Status Code
The resource key was successfully updated.
The request could not be understood due to malformed syntax.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
The resource could not be found.
The request could not be processed.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
{ "id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-key:23693f48-aaa2-4079-b0c7-334846eff8d0", "guid": "23693f48-aaa2-4079-b0c7-334846eff8d0", "url": "/v2/resource_keys/23693f48-aaa2-4079-b0c7-334846eff8d0", "created_at": "2018-07-02T22:03:43.837979455Z", "updated_at": "2018-07-02T22:03:43.837979455Z", "deleted_at": null, "source_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "name": "my-instance-new-key-1", "parameters": { "role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer" }, "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-key:23693f48-aaa2-4079-b0c7-334846eff8d0", "state": "active", "account_id": "4329073d16d2f3663f74bfa955259139", "resource_group_id": "0be5ad401ae913d8ff665d92680664ed", "resource_id": "dff97f5c-bc5e-4455-b470-411c3edbe49c", "credentials": { "apikey": "XXXX-YYYY-ZZZZ", "endpoints": "https://cos-service-armada-s.us-south.containers.mybluemix.net/endpoints", "iam_apikey_description": "Auto generated apikey during resource-key operation for Instance - crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "iam_apikey_name": "auto-generated-apikey-23693f48-aaa2-4079-b0c7-334846eff8d0", "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer", "iam_serviceid_crn": "crn:v1:bluemix:public:iam-identity::a/4329073d16d2f3663f74bfa955259139::serviceid:ServiceId-64c29e4f-422d-468c-a11b-1a8f671b5c89", "resource_instance_id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::" }, "iam_compatible": true, "migrated": false, "resource_instance_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94", "resource_alias_url": null }
Query Parameters
The short ID of the binding.
The human-readable name of the binding.
Short ID of the resource group.
The unique ID of the offering (service name). This value is provided by and stored in the global catalog.
Short ID of the binding in the specific targeted environment, e.g. service_binding_id in a given IBM Cloud environment.
Limit on how many items should be returned
Start date inclusive filter.
Example:
2019-01-08T00:00:00.000ZEnd date inclusive filter.
Example:
2019-01-08T00:00:00.000Z
curl -X GET \ https://resource-controller.cloud.ibm.com/v2/resource_bindings \ -H 'Authorization: Bearer <IAM_TOKEN>'
A list of resource bindings.
The URL for requesting the next page of results.
A list of resource bindings.
The number of resource bindings in
resources.
Status Code
The list of resource bindings was successfully retrieved.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
{ "rows_count": 1, "next_url": null, "resources": [ { "id": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-binding:25b88996-c117-484a-a233-0db73e9177fa", "guid": "25b88996-c117-484a-a233-0db73e9177fa", "url": "/v2/resource_bindings/25b88996-c117-484a-a233-0db73e9177fa", "created_at": "2018-09-24T15:26:06.849531355Z", "updated_at": "2018-09-24T15:26:06.849531355Z", "deleted_at": null, "source_crn": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-alias:267bf377-7fa2-43f6-94ec-09103a8e89d4", "target_crn": "crn:v1:bluemix:public:bluemix:eu-gb:s/f5038ca8-9d28-42a1-9e57-9b9fdd66bf8e::cf-application:b04ddee1-2838-449a-96d3-02a03179e991", "parameters": { "role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer" }, "crn": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-binding:25b88996-c117-484a-a233-0db73e9177fa", "region_binding_id": "684e7a0a-074f-4f97-ba5b-c0f57419fd84", "region_binding_crn": "crn:v1:bluemix:public:bluemix:eu-gb:s/f5038ca8-9d28-42a1-9e57-9b9fdd66bf8e::cf-service-binding:684e7a0a-074f-4f97-ba5b-c0f57419fd84", "account_id": "4329073d16d2f3663f74bfa955259139", "resource_group_id": "0be5ad401ae913d8ff665d92680664ed", "state": "active", "credentials": { "apikey": "XXX-YYY-ZZZ", "endpoints": "https://cos-service-armada-s.us-south.containers.mybluemix.net/endpoints", "iam_apikey_description": "Auto generated apikey during resource-bind operation for Instance - crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "iam_apikey_name": "auto-generated-apikey-25b88996-c117-484a-a233-0db73e9177fa", "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer", "iam_serviceid_crn": "crn:v1:bluemix:public:iam-identity::a/4329073d16d2f3663f74bfa955259139::serviceid:ServiceId-512311d5-ec96-42ea-92f4-efe5b29f7a71", "resource_instance_id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::" }, "iam_compatible": true, "resource_id": "dff97f5c-bc5e-4455-b470-411c3edbe49c", "migrated": false, "resource_alias_url": "/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4" } ] }
Property values for the new resource binding.
The short or long ID of resource alias.
Example:
25eba2a9-beef-450b-82cf-f5ad5e36c6ddThe CRN of application to bind to in a specific environment, e.g. Dallas YP, CFEE instance
Example:
crn:v1:bluemix:public:bluemix:us-south:s/0ba4dba0-a120-4a1e-a124-5a249a904b76::cf-application:a1caa40b-2c24-4da8-8267-ac2c1a42ad0cThe name of the binding. Must be 180 characters or less and cannot include any special characters other than
(space) - . _ :.Constraints: Value must match regular expression
^([^[:ascii:]]|[a-zA-Z0-9-._: ])+$Example:
my-bindingConfiguration options represented as key-value pairs. Service defined options are passed through to the target resource brokers, platform defined options are not.
An optional platform defined option to reuse an existing IAM serviceId for the role assignment.
Example:
crn:v1:bluemix:public:iam-identity::a/9fceaa56d1ab84893af6b9eec5ab81bb::serviceid:ServiceId-fe4c29b5-db13-410a-bacc-b5779a03d393
parameters
The role name or it's CRN.
Default:
WriterExample:
Writer
curl -X POST \ https://resource-controller.cloud.ibm.com/v2/resource_bindings \ -H 'Authorization: Bearer <>' \ -H 'Content-Type: application/json' \ -d '{ "name": "my-instance-binding-1", "source": "8d7af921-b136-4078-9666-081bd8470d94", "target": "crn:v1:bluemix:public:bluemix:eu-gb:s/f5038ca8-9d28-42a1-9e57-9b9fdd66bf8e::cf-application:b04ddee1-2838-449a-96d3-02a03179e991", "role": "Writer" }'
A resource binding.
The ID associated with the binding.
When you create a new binding, a globally unique identifier (GUID) is assigned. This GUID is a unique internal identifier managed by the resource controller that corresponds to the binding.
The full Cloud Resource Name (CRN) associated with the binding. For more information about this format, see Cloud Resource Names.
When you provision a new binding, a relative URL path is created identifying the location of the binding.
The human-readable name of the binding.
An alpha-numeric value identifying the account ID.
The short ID of the resource group.
The CRN of resource alias associated to the binding.
The CRN of target resource, e.g. application, in a specific environment.
The short ID of the binding in specific targeted environment, e.g.
service_binding_idin a given IBM Cloud environment.The state of the binding.
The credentials for the binding. Additional key-value pairs are passed through from the resource brokers. For additional details, see the service’s documentation.
The API key for the credentials.
The optional description of the API key.
The name of the API key.
The Cloud Resource Name for the role of the credentials.
The Cloud Resource Name for the service ID of the credentials.
Additional key-value pairs from the resource broker.
credentials
Specifies whether the binding’s credentials support IAM.
The relative path to the resource alias that this binding is associated with.
The date when the binding was created.
The date when the binding was last updated.
The date when the binding was deleted.
Status Code
Resource binding has been created
The request could not be understood due to malformed syntax.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
{ "id": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-binding:25b88996-c117-484a-a233-0db73e9177fa", "guid": "25b88996-c117-484a-a233-0db73e9177fa", "url": "/v2/resource_bindings/25b88996-c117-484a-a233-0db73e9177fa", "created_at": "2018-09-24T15:26:06.849531355Z", "updated_at": "2018-09-24T15:26:06.849531355Z", "deleted_at": null, "source_crn": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-alias:267bf377-7fa2-43f6-94ec-09103a8e89d4", "target_crn": "crn:v1:bluemix:public:bluemix:eu-gb:s/f5038ca8-9d28-42a1-9e57-9b9fdd66bf8e::cf-application:b04ddee1-2838-449a-96d3-02a03179e991", "parameters": { "role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer" }, "crn": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-binding:25b88996-c117-484a-a233-0db73e9177fa", "region_binding_id": "684e7a0a-074f-4f97-ba5b-c0f57419fd84", "region_binding_crn": "crn:v1:bluemix:public:bluemix:eu-gb:s/f5038ca8-9d28-42a1-9e57-9b9fdd66bf8e::cf-service-binding:684e7a0a-074f-4f97-ba5b-c0f57419fd84", "account_id": "4329073d16d2f3663f74bfa955259139", "resource_group_id": "0be5ad401ae913d8ff665d92680664ed", "state": "active", "credentials": { "apikey": "XXX-YYY-ZZZ", "endpoints": "https://cos-service-armada-s.us-south.containers.mybluemix.net/endpoints", "iam_apikey_description": "Auto generated apikey during resource-bind operation for Instance - crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "iam_apikey_name": "auto-generated-apikey-25b88996-c117-484a-a233-0db73e9177fa", "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer", "iam_serviceid_crn": "crn:v1:bluemix:public:iam-identity::a/4329073d16d2f3663f74bfa955259139::serviceid:ServiceId-512311d5-ec96-42ea-92f4-efe5b29f7a71", "resource_instance_id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::" }, "iam_compatible": true, "resource_id": "dff97f5c-bc5e-4455-b470-411c3edbe49c", "migrated": false, "resource_alias_url": "/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4" }
Path Parameters
The short or long ID of the binding.
curl -X GET \ https://resource-controller.cloud.ibm.com/v2/resource_bindings/25b88996-c117-484a-a233-0db73e9177fa \ -H 'Authorization: Bearer <IAM_TOKEN>'
A resource binding.
The ID associated with the binding.
When you create a new binding, a globally unique identifier (GUID) is assigned. This GUID is a unique internal identifier managed by the resource controller that corresponds to the binding.
The full Cloud Resource Name (CRN) associated with the binding. For more information about this format, see Cloud Resource Names.
When you provision a new binding, a relative URL path is created identifying the location of the binding.
The human-readable name of the binding.
An alpha-numeric value identifying the account ID.
The short ID of the resource group.
The CRN of resource alias associated to the binding.
The CRN of target resource, e.g. application, in a specific environment.
The short ID of the binding in specific targeted environment, e.g.
service_binding_idin a given IBM Cloud environment.The state of the binding.
The credentials for the binding. Additional key-value pairs are passed through from the resource brokers. For additional details, see the service’s documentation.
The API key for the credentials.
The optional description of the API key.
The name of the API key.
The Cloud Resource Name for the role of the credentials.
The Cloud Resource Name for the service ID of the credentials.
Additional key-value pairs from the resource broker.
credentials
Specifies whether the binding’s credentials support IAM.
The relative path to the resource alias that this binding is associated with.
The date when the binding was created.
The date when the binding was last updated.
The date when the binding was deleted.
Status Code
The resource binding was successfully retrieved.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
The resource could not be found.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
{ "id": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-binding:25b88996-c117-484a-a233-0db73e9177fa", "guid": "25b88996-c117-484a-a233-0db73e9177fa", "url": "/v2/resource_bindings/25b88996-c117-484a-a233-0db73e9177fa", "created_at": "2018-09-24T15:26:06.849531355Z", "updated_at": "2018-09-24T15:26:06.849531355Z", "deleted_at": null, "source_crn": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-alias:267bf377-7fa2-43f6-94ec-09103a8e89d4", "target_crn": "crn:v1:bluemix:public:bluemix:eu-gb:s/f5038ca8-9d28-42a1-9e57-9b9fdd66bf8e::cf-application:b04ddee1-2838-449a-96d3-02a03179e991", "parameters": { "role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer" }, "crn": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-binding:25b88996-c117-484a-a233-0db73e9177fa", "region_binding_id": "684e7a0a-074f-4f97-ba5b-c0f57419fd84", "region_binding_crn": "crn:v1:bluemix:public:bluemix:eu-gb:s/f5038ca8-9d28-42a1-9e57-9b9fdd66bf8e::cf-service-binding:684e7a0a-074f-4f97-ba5b-c0f57419fd84", "account_id": "4329073d16d2f3663f74bfa955259139", "resource_group_id": "0be5ad401ae913d8ff665d92680664ed", "state": "active", "credentials": { "apikey": "XXX-YYY-ZZZ", "endpoints": "https://cos-service-armada-s.us-south.containers.mybluemix.net/endpoints", "iam_apikey_description": "Auto generated apikey during resource-bind operation for Instance - crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "iam_apikey_name": "auto-generated-apikey-25b88996-c117-484a-a233-0db73e9177fa", "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer", "iam_serviceid_crn": "crn:v1:bluemix:public:iam-identity::a/4329073d16d2f3663f74bfa955259139::serviceid:ServiceId-512311d5-ec96-42ea-92f4-efe5b29f7a71", "resource_instance_id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::" }, "iam_compatible": true, "resource_id": "dff97f5c-bc5e-4455-b470-411c3edbe49c", "migrated": false, "resource_alias_url": "/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4" }
Path Parameters
The short or long ID of the binding.
curl -X DELETE \ https://resource-controller.cloud.ibm.com/v2/resource_bindings/25b88996-c117-484a-a233-0db73e9177fa \ -H 'Authorization: Bearer <IAM_TOKEN>'
Status Code
Successfully deleted binding.
The request could not be understood due to malformed syntax.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
The resource could not be found.
The resource could was previously deleted and is no longer available.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
No Sample Response
Path Parameters
The short or long ID of the binding.
Updated property values for the resource binding.
The new name of the binding. Must be 180 characters or less and cannot include any special characters other than
(space) - . _ :.Constraints: Value must match regular expression
^([^[:ascii:]]|[a-zA-Z0-9-._: ])+$Example:
my-new-binding-name
curl -X GET \ https://resource-controller.cloud.ibm.com/v2/resource_bindings/25b88996-c117-484a-a233-0db73e9177fa \ -H 'Authorization: Bearer <IAM_TOKEN>' -H 'Content-Type: application/json' \ -d '{ "name": "my-instance-new-binding-1" }'
A resource binding.
The ID associated with the binding.
When you create a new binding, a globally unique identifier (GUID) is assigned. This GUID is a unique internal identifier managed by the resource controller that corresponds to the binding.
The full Cloud Resource Name (CRN) associated with the binding. For more information about this format, see Cloud Resource Names.
When you provision a new binding, a relative URL path is created identifying the location of the binding.
The human-readable name of the binding.
An alpha-numeric value identifying the account ID.
The short ID of the resource group.
The CRN of resource alias associated to the binding.
The CRN of target resource, e.g. application, in a specific environment.
The short ID of the binding in specific targeted environment, e.g.
service_binding_idin a given IBM Cloud environment.The state of the binding.
The credentials for the binding. Additional key-value pairs are passed through from the resource brokers. For additional details, see the service’s documentation.
The API key for the credentials.
The optional description of the API key.
The name of the API key.
The Cloud Resource Name for the role of the credentials.
The Cloud Resource Name for the service ID of the credentials.
Additional key-value pairs from the resource broker.
credentials
Specifies whether the binding’s credentials support IAM.
The relative path to the resource alias that this binding is associated with.
The date when the binding was created.
The date when the binding was last updated.
The date when the binding was deleted.
Status Code
Successfully updated alias.
The request could not be understood due to malformed syntax.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
The resource could not be found.
The request could not be processed.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
{ "id": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-binding:25b88996-c117-484a-a233-0db73e9177fa", "guid": "25b88996-c117-484a-a233-0db73e9177fa", "url": "/v2/resource_bindings/25b88996-c117-484a-a233-0db73e9177fa", "created_at": "2018-09-24T15:26:06.849531355Z", "updated_at": "2018-09-24T15:26:06.849531355Z", "deleted_at": null, "source_crn": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-alias:267bf377-7fa2-43f6-94ec-09103a8e89d4", "target_crn": "crn:v1:bluemix:public:bluemix:eu-gb:s/f5038ca8-9d28-42a1-9e57-9b9fdd66bf8e::cf-application:b04ddee1-2838-449a-96d3-02a03179e991", "parameters": { "role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer" }, "crn": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-binding:25b88996-c117-484a-a233-0db73e9177fa", "region_binding_id": "684e7a0a-074f-4f97-ba5b-c0f57419fd84", "region_binding_crn": "crn:v1:bluemix:public:bluemix:eu-gb:s/f5038ca8-9d28-42a1-9e57-9b9fdd66bf8e::cf-service-binding:684e7a0a-074f-4f97-ba5b-c0f57419fd84", "account_id": "4329073d16d2f3663f74bfa955259139", "resource_group_id": "0be5ad401ae913d8ff665d92680664ed", "state": "active", "credentials": { "apikey": "XXX-YYY-ZZZ", "endpoints": "https://cos-service-armada-s.us-south.containers.mybluemix.net/endpoints", "iam_apikey_description": "Auto generated apikey during resource-bind operation for Instance - crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "iam_apikey_name": "auto-generated-apikey-25b88996-c117-484a-a233-0db73e9177fa", "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Writer", "iam_serviceid_crn": "crn:v1:bluemix:public:iam-identity::a/4329073d16d2f3663f74bfa955259139::serviceid:ServiceId-512311d5-ec96-42ea-92f4-efe5b29f7a71", "resource_instance_id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::" }, "iam_compatible": true, "resource_id": "dff97f5c-bc5e-4455-b470-411c3edbe49c", "migrated": false, "resource_alias_url": "/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4" }
Query Parameters
Short ID of the alias.
The human-readable name of the alias.
Resource instance short ID.
Short ID of the instance in a specific targeted environment. For example,
service_instance_idin a given IBM Cloud environment.The unique ID of the offering (service name). This value is provided by and stored in the global catalog.
Short ID of Resource group.
Limit on how many items should be returned.
Start date inclusive filter.
Example:
2019-01-08T00:00:00.000ZEnd date inclusive filter.
Example:
2019-01-08T00:00:00.000Z
curl -X GET \ https://resource-controller.cloud.ibm.com/v2/resource_aliases \ -H 'Authorization: Bearer <IAM_TOKEN>' \
A list of resource aliases.
The URL for requesting the next page of results.
A list of resource aliases.
The number of resource aliases in
resources.
Status Code
The list of aliases was successfully retrieved.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
The resource could not be found.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
{ "rows_count": 1, "next_url": "/v2/resource_aliases?next_docid=g2wAAAABaANkACNkYmNvcmVAZGIyMy5pYm0tYnNzMDAxLmNsb3VkYW50Lm5ldGwAAAACbgQAAAAA4G4EAP____9qbAAAAAJGQnZ4Bfh4oABiAAARN2pq&limit=1&account_id=d86af7367f70fba4f306d3c19c7344b2", "resources": [ { "id": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-alias:267bf377-7fa2-43f6-94ec-09103a8e89d4", "guid": "267bf377-7fa2-43f6-94ec-09103a8e89d4", "url": "/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4", "created_at": "2018-04-19T00:21:02.735586861Z", "updated_at": "2018-04-26T18:05:58.851303427Z", "deleted_at": null, "name": "my-instance-alias-1", "resource_instance_id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "target_crn": "crn:v1:bluemix:public:bluemix:eu-gb:o/e242c7f0-9eb7-4541-ad3e-b5f5a45a1498::cf-space:f5038ca8-9d28-42a1-9e57-9b9fdd66bf8e", "account_id": "4329073d16d2f3663f74bfa955259139", "resource_id": "dff97f5c-bc5e-4455-b470-411c3edbe49c", "resource_group_id": "0be5ad401ae913d8ff665d92680664ed", "crn": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-alias:267bf377-7fa2-43f6-94ec-09103a8e89d4", "region_instance_id": "3ea43c9c-c987-481e-9fff-283dcec927a3", "region_instance_crn": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:s/f5038ca8-9d28-42a1-9e57-9b9fdd66bf8e:3ea43c9c-c987-481e-9fff-283dcec927a3:cf-service-instance:", "state": "active", "migrated": false, "resource_instance_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94", "resource_bindings_url": "/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4/resource_bindings", "resource_keys_url": "/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4/resource_keys" } ] }
Create a new resource alias
Alias a resource instance into a targeted environment's (name)space.
POST /resource_aliasesProperty values for the new resource alias.
The name of the alias. Must be 180 characters or less and cannot include any special characters other than
(space) - . _ :.Constraints: Value must match regular expression
^([^[:ascii:]]|[a-zA-Z0-9-._: ])+$Example:
my-aliasThe short or long ID of resource instance.
Example:
a8dff6d3-d287-4668-a81d-c87c55c2656dThe CRN of target name(space) in a specific environment, e.g. space in Dallas YP, CFEE instance etc.
Example:
crn:v1:bluemix:public:bluemix:us-south:o/5e939cd5-6377-4383-b9e0-9db22cd11753::cf-space:66c8b915-101a-406c-a784-e6636676e4f5
curl -X POST \ https://resource-controller.cloud.ibm.com/v2/resource_aliases \ -H 'Authorization: Bearer <IAM_TOKEN>' \ -H 'Content-Type: application/json' \ -d '{ "name": "my-instance-alias-1", "source": "8d7af921-b136-4078-9666-081bd8470d94", "target": "crn:v1:bluemix:public:bluemix:eu-gb:o/e242c7f0-9eb7-4541-ad3e-b5f5a45a1498::cf-space:f5038ca8-9d28-42a1-9e57-9b9fdd66bf8e" }'
A resource alias.
The ID associated with the alias.
When you create a new alias, a globally unique identifier (GUID) is assigned. This GUID is a unique internal indentifier managed by the resource controller that corresponds to the alias.
The full Cloud Resource Name (CRN) associated with the alias. For more information about this format, see Cloud Resource Names.
When you created a new alias, a relative URL path is created identifying the location of the alias.
The human-readable name of the alias.
An alpha-numeric value identifying the account ID.
The short ID of the resource group.
The long ID (full CRN) of the resource group.
The CRN of the target namespace in the specific environment.
The state of the alias.
The short ID of the resource instance.
The short ID of the instance in the specific target environment, e.g.
service_instance_idin a given IBM Cloud environment.The relative path to the instance.
The relative path to the resource bindings for the alias.
The relative path to the resource keys for the alias.
The date when the alias was created.
The date when the alias was last updated.
The date when the alias was deleted.
Status Code
Alias has been created.
The request could not be understood due to malformed syntax.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
The resource could not be found.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
{ "id": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-alias:267bf377-7fa2-43f6-94ec-09103a8e89d4", "guid": "267bf377-7fa2-43f6-94ec-09103a8e89d4", "url": "/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4", "created_at": "2018-04-19T00:21:02.735586861Z", "updated_at": "2018-04-26T18:05:58.851303427Z", "deleted_at": null, "name": "my-instance-alias-1", "resource_instance_id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "target_crn": "crn:v1:bluemix:public:bluemix:eu-gb:o/e242c7f0-9eb7-4541-ad3e-b5f5a45a1498::cf-space:f5038ca8-9d28-42a1-9e57-9b9fdd66bf8e", "account_id": "4329073d16d2f3663f74bfa955259139", "resource_id": "dff97f5c-bc5e-4455-b470-411c3edbe49c", "resource_group_id": "0be5ad401ae913d8ff665d92680664ed", "crn": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-alias:267bf377-7fa2-43f6-94ec-09103a8e89d4", "region_instance_id": "3ea43c9c-c987-481e-9fff-283dcec927a3", "region_instance_crn": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:s/f5038ca8-9d28-42a1-9e57-9b9fdd66bf8e:3ea43c9c-c987-481e-9fff-283dcec927a3:cf-service-instance:", "state": "active", "migrated": false, "resource_instance_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94", "resource_bindings_url": "/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4/resource_bindings", "resource_keys_url": "/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4/resource_keys" }
Path Parameters
The short or long ID of the alias.
curl -X GET \ https://resource-controller.cloud.ibm.com/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4 \ -H 'Authorization: Bearer <IAM_TOKEN>' \
A resource alias.
The ID associated with the alias.
When you create a new alias, a globally unique identifier (GUID) is assigned. This GUID is a unique internal indentifier managed by the resource controller that corresponds to the alias.
The full Cloud Resource Name (CRN) associated with the alias. For more information about this format, see Cloud Resource Names.
When you created a new alias, a relative URL path is created identifying the location of the alias.
The human-readable name of the alias.
An alpha-numeric value identifying the account ID.
The short ID of the resource group.
The long ID (full CRN) of the resource group.
The CRN of the target namespace in the specific environment.
The state of the alias.
The short ID of the resource instance.
The short ID of the instance in the specific target environment, e.g.
service_instance_idin a given IBM Cloud environment.The relative path to the instance.
The relative path to the resource bindings for the alias.
The relative path to the resource keys for the alias.
The date when the alias was created.
The date when the alias was last updated.
The date when the alias was deleted.
Status Code
The alias was successfully retrieved.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
The resource could not be found.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
{ "id": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-alias:267bf377-7fa2-43f6-94ec-09103a8e89d4", "guid": "267bf377-7fa2-43f6-94ec-09103a8e89d4", "url": "/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4", "created_at": "2018-04-19T00:21:02.735586861Z", "updated_at": "2018-04-26T18:05:58.851303427Z", "deleted_at": null, "name": "my-instance-alias-1", "resource_instance_id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "target_crn": "crn:v1:bluemix:public:bluemix:eu-gb:o/e242c7f0-9eb7-4541-ad3e-b5f5a45a1498::cf-space:f5038ca8-9d28-42a1-9e57-9b9fdd66bf8e", "account_id": "4329073d16d2f3663f74bfa955259139", "resource_id": "dff97f5c-bc5e-4455-b470-411c3edbe49c", "resource_group_id": "0be5ad401ae913d8ff665d92680664ed", "crn": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-alias:267bf377-7fa2-43f6-94ec-09103a8e89d4", "region_instance_id": "3ea43c9c-c987-481e-9fff-283dcec927a3", "region_instance_crn": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:s/f5038ca8-9d28-42a1-9e57-9b9fdd66bf8e:3ea43c9c-c987-481e-9fff-283dcec927a3:cf-service-instance:", "state": "active", "migrated": false, "resource_instance_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94", "resource_bindings_url": "/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4/resource_bindings", "resource_keys_url": "/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4/resource_keys" }
Path Parameters
The short or long ID of the alias.
curl -X DELETE \ https://resource-controller.cloud.ibm.com/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4 \ -H 'Authorization: Bearer <IAM_TOKEN>' \
Status Code
Successfully deleted alias.
The request could not be understood due to malformed syntax.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
The resource could not be found.
The resource could was previously deleted and is no longer available.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
No Sample Response
Path Parameters
The short or long ID of the alias.
Updated property values for a resource alias.
The new name of the alias. Must be 180 characters or less and cannot include any special characters other than
(space) - . _ :.Constraints: Value must match regular expression
^([^[:ascii:]]|[a-zA-Z0-9-._: ])+$Example:
my-new-alias-name
curl -X PATCH \ https://resource-controller.cloud.ibm.com/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4 \ -H 'Authorization: Bearer <IAM_TOKEN>' \ -H 'Content-Type: application/json' \ -d '{ "name": "my-instance-new-alias-1" }'
A resource alias.
The ID associated with the alias.
When you create a new alias, a globally unique identifier (GUID) is assigned. This GUID is a unique internal indentifier managed by the resource controller that corresponds to the alias.
The full Cloud Resource Name (CRN) associated with the alias. For more information about this format, see Cloud Resource Names.
When you created a new alias, a relative URL path is created identifying the location of the alias.
The human-readable name of the alias.
An alpha-numeric value identifying the account ID.
The short ID of the resource group.
The long ID (full CRN) of the resource group.
The CRN of the target namespace in the specific environment.
The state of the alias.
The short ID of the resource instance.
The short ID of the instance in the specific target environment, e.g.
service_instance_idin a given IBM Cloud environment.The relative path to the instance.
The relative path to the resource bindings for the alias.
The relative path to the resource keys for the alias.
The date when the alias was created.
The date when the alias was last updated.
The date when the alias was deleted.
Status Code
Successfully updated alias.
The request could not be understood due to malformed syntax.
Your access token is invalid or authenication of your token failed.
Your access token is valid but does not have the necessary permissions to access this resource.
The resource could not be found.
The request could not be processed.
Too many requests. Please wait a few minutes and try again.
Your request could not be processed. Please try again later. If the problem persists, note the
transaction-idin the response header and contact IBM Cloud support.
{ "id": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-alias:267bf377-7fa2-43f6-94ec-09103a8e89d4", "guid": "267bf377-7fa2-43f6-94ec-09103a8e89d4", "url": "/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4", "created_at": "2018-04-19T00:21:02.735586861Z", "updated_at": "2018-04-26T18:05:58.851303427Z", "deleted_at": null, "name": "my-instance-new-alias-1", "resource_instance_id": "crn:v1:bluemix:public:cloud-object-storage:global:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94::", "target_crn": "crn:v1:bluemix:public:bluemix:eu-gb:o/e242c7f0-9eb7-4541-ad3e-b5f5a45a1498::cf-space:f5038ca8-9d28-42a1-9e57-9b9fdd66bf8e", "account_id": "4329073d16d2f3663f74bfa955259139", "resource_id": "dff97f5c-bc5e-4455-b470-411c3edbe49c", "resource_group_id": "0be5ad401ae913d8ff665d92680664ed", "crn": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:a/4329073d16d2f3663f74bfa955259139:8d7af921-b136-4078-9666-081bd8470d94:resource-alias:267bf377-7fa2-43f6-94ec-09103a8e89d4", "region_instance_id": "3ea43c9c-c987-481e-9fff-283dcec927a3", "region_instance_crn": "crn:v1:bluemix:public:cloud-object-storage:eu-gb:s/f5038ca8-9d28-42a1-9e57-9b9fdd66bf8e:3ea43c9c-c987-481e-9fff-283dcec927a3:cf-service-instance:", "state": "active", "migrated": false, "resource_instance_url": "/v2/resource_instances/8d7af921-b136-4078-9666-081bd8470d94", "resource_bindings_url": "/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4/resource_bindings", "resource_keys_url": "/v2/resource_aliases/267bf377-7fa2-43f6-94ec-09103a8e89d4/resource_keys" }