Replace service credentials.

PUT

/api/web/namespaces/{namespace}/service_credentials/{name}

curl --request PUT \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/namespaces/example/service_credentials/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "namespace": "example", "namespace_access": { "namespace_role_map": {} }, "user_group_names": [ "example" ] }'

• F5 Distributed Cloud Console

Request to replace user_groups and roles in service credentials. Note - for updating expiry use RenewServiceCredentials and to active/inactive service credential use ActivateServiceCredentials API.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Namespace of the service credential user. Value of namespace is always “system”.

name

required

string

Service Credential name

x-required Name of service credential object.

Request Body^required

Media typeapplication/json

Replace Service Credentials Request

Request format for replacing service credentials.

object

name

Service Credential name

Name of service credential object. Required: YES.

string

>= 6 characters <= 1024 characters

namespace

namespace

Namespace of the service credential user. Value of namespace is always “system”.

string

>= 6 characters <= 1024 characters

namespace_access

object

namespace_role_map

Namespace Role Map

List of all the roles for the entity in the namespaces Required: YES.

object

user_group_names

User Groups Names

List of user_groups to be replaced for this service credentials.

Array<string>

Example^generated

{
  "name": "example",
  "namespace": "example",
  "namespace_access": {
    "namespace_role_map": {}
  },
  "user_group_names": [
    "example"
  ]
}

Responses

200

A successful response.

Media typeapplication/json

Replace service credentials response

Response format for the credential’s replace request.

object

active

Active

Specifies if service credential is active or not.

boolean format: boolean

expiration_timestamp

Expiry

Specifies the expiration timestamp.

string format: date-time

<= 1024 characters

name

Name

Name of API credential record.

string

>= 6 characters <= 1024 characters

Example^generated

{
  "active": true,
  "expiration_timestamp": "2026-04-15T12:00:00Z",
  "name": "example"
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example