Roles: Edit

Description

Modify the attributes of a given Role.

HTTP Request

PATCH /api/v1beta0/global/roles/roleId/

Parameters

Name Required Description Location
roleId
integer
Yes

The ID of a Role object.

path

Request body

The JSON representation of a Role object.

The body must be a valid Role object. Example value:

{
  "category": {
    "id": 1
  }, 
  "description": "string", 
  "name": "string", 
  "quickStart": true, 
  "quickStartGroup": "string", 
  "tags": [
    "string"
  ]
}

Successful Response (Status 200)

The JSON representation of a Role object.

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

{
  "data": {
    "builtinAutomation": [
      "base"
    ], 
    "category": {
      "id": 1
    }, 
    "deprecated": {
      "deprecated": "2013-01-01T12:34:56.789Z", 
      "replacement": {
        "id": 1
      }
    }, 
    "description": "string", 
    "id": 1, 
    "name": "string", 
    "os": {
      "id": "string"
    }, 
    "quickStart": true, 
    "quickStartGroup": "string", 
    "scope": "scalr", 
    "tags": [
      "string"
    ], 
    "useScalrAgent": true
  }, 
  "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
roleId

The ID of a Role object.

body

The JSON representation of a Role object.