Cloud Credentials: Edit

Description

Modify the attributes of given Cloud Credentials.

HTTP Request

PATCH /api/v1beta0/account/accountId/cloud-credentials/cloudCredentialsId/

Parameters

Name Required Description Location
accountId
integer
Yes

The ID of the Account scoping this request.

path
cloudCredentialsId
string
Yes

The ID of a CloudCredentials object.

path

Request body

The JSON representation of a CloudCredentials object.

CloudCredentials is an abstract type, you need to provide an object of a concrete type implementing it:

Successful Response (Status 200)

The JSON representation of a CloudCredentials object.

The API replies with a CloudCredentialsDetailsResponse object. Example response body:

{
  "data": {
    "cloudCredentialsType": "CloudCredentials", 
    "description": "string", 
    "id": "string", 
    "name": "string", 
    "provider": "string", 
    "scope": "scalr", 
    "status": "disabled"
  }, 
  "errors": [
    {
      "code": "string", 
      "message": "string"
    }
  ], 
  "meta": {
    "sample": "string"
  }, 
  "warnings": [
    {
      "code": "string", 
      "message": "string"
    }
  ]
}

Other Response Messages

HTTP Status Code Reason Response Model
400

A client-side error was made.

An ApiErrorResponse object
401

The request was not authenticated.

An ApiErrorResponse object
403

Insufficient permissions.

An ApiErrorResponse object
404

Resource not found.

An ApiErrorResponse object
409

Conflict with current state.

An ApiErrorResponse object
422

This request was well-formed but was rejected due to semantic errors.

An ApiErrorResponse object
500

A server-side error occurred.

An ApiErrorResponse object
501

This feature is not implemented in Scalr.

An ApiErrorResponse object
503

The service is currently unavailable.

An ApiErrorResponse object

Try it out!

Parameter Value Description
accountId

The ID of the Account scoping this request.

cloudCredentialsId

The ID of a CloudCredentials object.

body
- Definition

The JSON representation of a CloudCredentials object.