Sign in
playground-settings

Create Playground Settings

Create playground settings.

post/api/v1/playground-settings

Request body

namestring nullable
descriptionstring nullable
settingsobject required
settings_type'complex' | 'simple'
oauth_enabledboolean nullable
oauth_token_urlstring nullable
oauth_client_idstring nullable
oauth_client_secretstring nullable
oauth_token_endpoint_auth_method'client_secret_basic' | 'client_secret_post' nullable
oauth_paramsobject nullable
oauth_headersobject nullable

Response

Successful Response

idstring uuid required
settingsobject required
namestring nullable
created_atstring date-time required
updated_atstring date-time required
descriptionstring nullable
settings_type'complex' | 'simple'
created_by_ls_user_idstring uuid nullable
updated_by_ls_user_idstring uuid nullable
available_in_playgroundboolean
available_in_evaluatorsboolean
available_in_agent_builderboolean
available_in_pollyboolean
available_in_insights_heavyboolean
available_in_insights_lightboolean
oauth_enabledboolean nullable
oauth_token_urlstring nullable
oauth_client_idstring nullable
oauth_client_secretstring nullable
oauth_token_endpoint_auth_method'client_secret_basic' | 'client_secret_post' nullable
oauth_paramsobject nullable
oauth_headersobject nullable

Changes

Changed in 2 of the 48 revisions of this API.216

  • a0acb3a6a101214See the full diff
    • ●

      removed the optional property available_in_issues_agent_heavy from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property available_in_issues_agent_light from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional request property oauth_client_id

      new-optional-request-property

    • ○

      added the new optional request property oauth_client_secret

      new-optional-request-property

    • ○

      added the new optional request property oauth_enabled

      new-optional-request-property

    • ○

      added the new optional request property oauth_headers

      new-optional-request-property

    • ○

      added the new optional request property oauth_params

      new-optional-request-property

    • ○

      added the new optional request property oauth_token_endpoint_auth_method

      new-optional-request-property

    • ○

      added the new optional request property oauth_token_url

      new-optional-request-property

    • ○

      added the optional property oauth_client_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property oauth_client_secret to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property oauth_enabled to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property oauth_headers to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property oauth_params to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property oauth_token_endpoint_auth_method to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property oauth_token_url to the response with the 200 status

      response-optional-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 99490d1e837e2See the full diff
    • ○

      added the optional property available_in_issues_agent_heavy to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property available_in_issues_agent_light to the response with the 200 status

      response-optional-property-added

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog