[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]

vmware-cloud-director

Update Service App

Description

Updates a specific VMware service application.

Request

URL

put

https://{api_host}/cloudapi/1.0.0/serviceApps/{serviceAppId}

Copy

Path Parameters

string

serviceAppId Required

Request Body

ServiceApp of type(s) application/json Required

Show optional properties

{}

{
    "authorizationUrl": "https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize"
}

string

name Required

The name of the service application

string

clientId Required

The client ID

string

clientSecret Required

The client secret

ServiceAppScope

serviceScope Required

The scope of the service application

string as date-time

accessTokenExpiration Optional

The read-only expiration date of the access token.

string

authorizationUrl Optional

The authorization URL for the application.

boolean

enabled Optional

Whether the application is currently enabled.

string

id Optional

The unique ID for the service application. This field is read-only.

integer

accessTokenTTL Optional

The read-only time-to-live of the access token in seconds.

string

orgId Optional

The external organization id of the service application

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Response

Response Body

200 OK

Returns ServiceApp of type(s) application/json;version=37.2

{
    "authorizationUrl": "https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize"
}

string

name Required

The name of the service application

string

clientId Required

The client ID

string

clientSecret Required

The client secret

ServiceAppScope

serviceScope Required

The scope of the service application

string as date-time

accessTokenExpiration Optional

The read-only expiration date of the access token.

string

authorizationUrl Optional

The authorization URL for the application.

boolean

enabled Optional

Whether the application is currently enabled.

string

id Optional

The unique ID for the service application. This field is read-only.

integer

accessTokenTTL Optional

The read-only time-to-live of the access token in seconds.

string

orgId Optional

The external organization id of the service application

Errors

Error

400

Invalid configuration.

Error

404

The specified resource was not found

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"authorizationUrl":"https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize"}' https://{api_host}/cloudapi/1.0.0/serviceApps/{serviceAppId}

vmware-cloud-director

Availability

Added in 32.0

Service App Operations

delete

Delete Service App

get

Get Service App

put

Update Service App

Update Service App

Request

URL

Path Parameters

Request Body

Authentication

ApiKeyAuth

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

Availability

On This Page

Service App Operations

Was this page helpful?