Jump to

• Request
• Response

Modify This Restful Management Services

post

/management/weblogic/{version}/edit/restfulManagementServices

Modify this restful management services.

Request

Supported Media Types

• application/json

Path Parameters

• version: string
  The version of the WebLogic REST interface.

Header Parameters

• X-Requested-By: string
  The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.

Body ()

Must contain the modified restful management services model.

Root Schema : Restful Management Services

Type: object

Show Source

• CORSAllowedCredentials(optional): boolean
  Default Value: false

  Determines if credentials are allowed for CORS requests.

  When the value is false, the response will not include the corresponding CORS HTTP header.

• CORSAllowedHeaders(optional): string
  Default Value: *

  Determines the value of allowed HTTP headers for CORS requests.

  The allowed headers value is a string that contains a comma separated list of HTTP header names. The default setting allows all headers.

  When the value is empty or not specified, the response will not include the corresponding CORS HTTP header.

• CORSAllowedMethods(optional): string
  Default Value: *

  Determines the value of allowed HTTP methods for CORS requests.

  The allowed methods value is a string that contains a comma separated list of HTTP method names. The default setting allows all methods.

  When the value is empty or not specified, the response will not include the corresponding CORS HTTP header.

• CORSAllowedOrigins(optional): array Items
  Title: Items

  Determines the list of allowed origins for CORS requests. When the list is empty or not specified and CORS support is enabled then all origins are accepted. When specified the HTTP Origin header must match exactly one of the values configured as allowed.

  CORS origin values include protocol and domain name, they may also contain port numbers. Multiple variants of the allowed origin may need to be specified based on the origin used by the browser.

• CORSEnabled(optional): boolean
  Default Value: false

  Enables the support of CORS (Cross-Origin Resource Sharing) processing in the RESTful Management Services Web application.

• CORSExposedHeaders(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@21d082c1

  Determines the value of exposed HTTP headers for CORS requests.

  The exposed headers value is a string that contains a comma separated list of HTTP header names. The default setting does not specify any specific headers.

  When the value is empty or not specified, the response will not include the corresponding CORS HTTP header.

• CORSMaxAge(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@81a67d6

  Determines the number of seconds for a browser cache of CORS preflight requests.

  The max age value is a string that contains a numeric value with the number of seconds used for the browser cache. The default setting does not specify any value.

  When the value is empty or not specified, the response will not include the corresponding CORS HTTP header.

• delegatedRequestConnectTimeoutMillis(optional): integer(int32)
  Minimum Value: 0

  Default Value: 30000

  Determines the connection timeout, in milliseconds, when the Management Services Web application propagates an idempotent REST request from the admin server to a managed server.

  If DelegatedRequestConnectTimeouttMillis is zero, then the default underlying JAXRS client api connection timeout will be used.

• delegatedRequestMaxWaitMillis(optional): integer(int32)
  Minimum Value: 0

  Default Value: 0

  Determines how long the Management Services Web application will wait, in milliseconds, when it propagates an idempotent REST request from the admin server to a managed server. If zero, then it will try to propagate the request once. If greater than zero, then it will retry the request until it finishes or until it detects that the time limit has been exceeded.

  .

  A request can override this value by specifying the requestMaxWaitMillis query parameter.

• delegatedRequestMinThreads(optional): integer(int32)
  Minimum Value: 1

  Default Value: 25

  Specifies the minimum number of threads that should be dedicated to the Management Services Web application when interacting with managed servers in parallel for improved responsiveness in large domains.

• delegatedRequestReadTimeoutMillis(optional): integer(int32)
  Minimum Value: 0

  Default Value: 10000

  Determines the read timeout, in milliseconds, when the Management Services Web application propagates an idempotent REST request from the admin server to a managed server.

  If DelegatedRequestReadTimeoutMillis is zero, then the default underlying JAXRS client api read timeout will be used.

• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

  Return whether the MBean was created dynamically or is persisted to config.xml

• enabled(optional): boolean
  Default Value: true

  Enables the monitoring of this WebLogic Server domain through the RESTful Management Services Web application.

• fannedOutRequestMaxWaitMillis(optional): integer(int32)
  Minimum Value: 0

  Default Value: 180000

  Determines how long the Management Services Web application will wait, in milliseconds, when it fans out an idempotent REST request from the admin server to all the managed servers. If zero, then it will choose an appropriate timeout.

  .

  A request can override this value by specifying the requestMaxWaitMillis query parameter.

• id(optional): integer(int64)
  Read Only: true

  Return the unique id of this MBean instance

• javaServiceResourcesEnabled(optional): boolean

  Specifies whether the REST resource features for administering WebLogic Server as a Java Service within a cloud environment should be enabled in this domain.

• name(optional): string
  Read Only: true

  The user-specified name of this MBean instance.

  This name is included as one of the key properties in the MBean's javax.management.ObjectName

  Name=user-specified-name

  Constraints

  • legal null
• notes(optional): string

  Optional information that you can include to describe this configuration.

  WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the xml entity <. Carriage returns/line feeds are preserved.

  Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "CORSAllowedCredentials":{
            "default":false,
            "type":"boolean",
            "description":"<p>Determines if credentials are allowed for CORS requests.</p><p>When the value is false, the response will not include the corresponding CORS HTTP header.</p>"
        },
        "CORSAllowedHeaders":{
            "default":"*",
            "type":"string",
            "description":"<p>Determines the value of allowed HTTP headers for CORS requests.</p><p>The allowed headers value is a string that contains a comma separated list of HTTP header names. The default setting allows all headers.</p><p>When the value is empty or not specified, the response will not include the corresponding CORS HTTP header.</p>"
        },
        "CORSAllowedMethods":{
            "default":"*",
            "type":"string",
            "description":"<p>Determines the value of allowed HTTP methods for CORS requests.</p><p>The allowed methods value is a string that contains a comma separated list of HTTP method names. The default setting allows all methods.</p><p>When the value is empty or not specified, the response will not include the corresponding CORS HTTP header.</p>"
        },
        "CORSAllowedOrigins":{
            "default":null,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Determines the list of allowed origins for CORS requests. When the list is empty or not specified and CORS support is enabled then all origins are accepted. When specified the HTTP Origin header must match exactly one of the values configured as allowed.</p><p>CORS origin values include protocol and domain name, they may also contain port numbers. Multiple variants of the allowed origin may need to be specified based on the origin used by the browser.</p>"
        },
        "CORSEnabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>Enables the support of CORS (Cross-Origin Resource Sharing) processing in the RESTful Management Services Web application.</p>"
        },
        "CORSExposedHeaders":{
            "default":null,
            "type":"string",
            "description":"<p>Determines the value of exposed HTTP headers for CORS requests.</p><p>The exposed headers value is a string that contains a comma separated list of HTTP header names. The default setting does not specify any specific headers.</p><p>When the value is empty or not specified, the response will not include the corresponding CORS HTTP header.</p>"
        },
        "CORSMaxAge":{
            "default":null,
            "type":"string",
            "description":"<p>Determines the number of seconds for a browser cache of CORS preflight requests.</p><p>The max age value is a string that contains a numeric value with the number of seconds used for the browser cache. The default setting does not specify any value.</p><p>When the value is empty or not specified, the response will not include the corresponding CORS HTTP header.</p>"
        },
        "delegatedRequestConnectTimeoutMillis":{
            "default":30000,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>Determines the connection timeout, in milliseconds, when the Management Services Web application propagates an idempotent REST request from the admin server to a managed server.</p><p> If DelegatedRequestConnectTimeouttMillis is zero, then the default underlying JAXRS client api connection timeout will be used.</p>"
        },
        "delegatedRequestMaxWaitMillis":{
            "default":0,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>Determines how long the Management Services Web application will wait, in milliseconds, when it propagates an idempotent REST request from the admin server to a managed server.  If zero, then it will try to propagate the request once. If greater than zero, then it will retry the request until it finishes or until it detects that the time limit has been exceeded.</p><p>. </p><p>A request can override this value by specifying the requestMaxWaitMillis query parameter.</p>"
        },
        "delegatedRequestMinThreads":{
            "default":25,
            "minimum":1,
            "type":"integer",
            "format":"int32",
            "description":"<p>Specifies the minimum number of threads that should be dedicated to the Management Services Web application when interacting with managed servers in parallel for improved responsiveness in large domains.</p>"
        },
        "delegatedRequestReadTimeoutMillis":{
            "default":10000,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>Determines the read timeout, in milliseconds, when the Management Services Web application propagates an idempotent REST request from the admin server to a managed server.</p><p> If DelegatedRequestReadTimeoutMillis is zero, then the default underlying JAXRS client api read timeout will be used.</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "enabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Enables the monitoring of this WebLogic Server domain through the RESTful Management Services Web application.</p>"
        },
        "fannedOutRequestMaxWaitMillis":{
            "default":180000,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>Determines how long the Management Services Web application will wait, in milliseconds, when it fans out an idempotent REST request from the admin server to all the managed servers.  If zero, then it will choose an appropriate timeout. </p><p>. </p><p>A request can override this value by specifying the requestMaxWaitMillis query parameter.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "javaServiceResourcesEnabled":{
            "type":"boolean",
            "description":"<p>Specifies whether the REST resource features for administering WebLogic Server as a Java Service within a cloud environment should be enabled in this domain.</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

Determines the list of allowed origins for CORS requests. When the list is empty or not specified and CORS support is enabled then all origins are accepted. When specified the HTTP Origin header must match exactly one of the values configured as allowed.

CORS origin values include protocol and domain name, they may also contain port numbers. Multiple variants of the allowed origin may need to be specified based on the origin used by the browser.

Default Value: oracle.doceng.json.BetterJsonNull@61c83b0e

Show Source

• Array of: string

{
    "default":null,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Determines the list of allowed origins for CORS requests. When the list is empty or not specified and CORS support is enabled then all origins are accepted. When specified the HTTP Origin header must match exactly one of the values configured as allowed.</p><p>CORS origin values include protocol and domain name, they may also contain port numbers. Multiple variants of the allowed origin may need to be specified based on the origin used by the browser.</p>"
}

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.

Back to Top

Response

200 Response

Back to Top