Get Ssh Server Setting - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get Ssh Server Setting","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Get the SSH server setting associated with the specified ID for a particular chassis platform settings policy.**","operationId":"getSshServerSetting","parameters":[{"description":"Unique identifier of the SSH server setting.","in":"path","name":"objectId","required":true,"schema":{"type":"string"}},{"description":"UUID of the ticket for tracking the configuration changes.","in":"header","name":"ticket-id","required":false,"schema":{"type":"string"}},{"description":"The container id under which this specific resource is contained.","in":"path","name":"containerUUID","required":true,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshserversettings ( Example payload for GET on SshServerSetting Policy )":{"value":{"items":[{"enableSshServer":true,"encryptAlgo":["3des-cbc","aes128-cbc","aes128-ctr"],"hostKey":1032,"id":"sshserversettingsUUID","kexAlgo":["curve25519-sha256","curve25519-sha256"],"links":{"self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshserversettings/sshserversettingsUUID"},"macAlgo":["hmac-sha-1","hmac-sha2-256"],"metadata":{"domain":{"id":"domainUUID","name":"Global","type":"Domain"},"timestamp":1639639589846},"timeRekeyLimit":120,"type":"SshServerSetting","volumeRekeyLimit":3978}],"links":{"self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshserversettings?offset=0&limit=25&expanded=true"},"paging":{"count":2,"limit":25,"offset":0,"pages":1}}},"Example 2 : GET /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshserversettings/sshserversettingsUUID ( Example payload for GET on SshServerSetting policy )":{"value":{"enableSshServer":true,"encryptAlgo":["3des-cbc","aes128-cbc","aes128-ctr"],"hostKey":1032,"id":"sshserversettingsUUID","kexAlgo":["curve25519-sha256","curve25519-sha256"],"links":{"self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshserversettings/sshserversettingsUUID"},"macAlgo":["hmac-sha-1","hmac-sha2-256"],"metadata":{"domain":{"id":"domainUUID","name":"Global","type":"Domain"},"timestamp":1639639589846},"timeRekeyLimit":120,"type":"SshServerSetting","volumeRekeyLimit":3978}}},"schema":{"type":"object","description":"Description of Ssh Server Setting policy","properties":{"description":{"type":"string"},"enableSshServer":{"description":"enable ssh server","type":"boolean"},"encryptAlgo":{"description":"List of encryption algorithms. Supported Encryption Algorithms: 3des-cbc, aes128-cbc, aes128-ctr, aes128-gcm_openssh_com, aes192-cbc, aes192-ctr, aes256-cbc, aes256-ctr, aes256-gcm_openssh_com, chacha20-poly1305_openssh_com","items":{"type":"string"},"type":"array"},"hostKey":{"description":"Indicates modulus size for the RSA server host key","format":"int32","type":"integer"},"id":{"description":"Version number of the response object.","type":"string"},"kexAlgo":{"description":"List of key exchange algorithms. Supported Key Exchange Algorithms: curve25519-sha256, curve25519-sha256_libssh_org, diffie-hellman-group14-sha1, diffie-hellman-group14-sha256, ecdh-sha2-nistp256, ecdh-sha2-nistp384, ecdh-sha2-nistp521","items":{"type":"string"},"type":"array"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"macAlgo":{"description":"List of MAC algorithms. Supported Mac Algorithms: hmac-sha-1, hmac-sha2-256, hmac-sha2-512","items":{"type":"string"},"type":"array"},"metadata":{"description":"Object representing metadata attributes for the Ssh Server Setting policy.","type":"object","properties":{"domain":{"description":"Defines the domains this instance belongs to (if applicable).","type":"object","properties":{"id":{"description":"Unique UUID of this domain","type":"string"},"links":{"description":"Links to the domain resource URLs.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the domain.","type":"string"},"type":{"description":"Domain type definition (fixed).","type":"string"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/Domain"},"isLocked":{"type":"boolean"},"lastUser":{"description":"The last user who modified this instance.","type":"object","properties":{"id":{"description":"The unique UUID of the user","type":"string"},"links":{"description":"Contains the self referencing links to this resource","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the user.","type":"string"},"type":{"description":"The user type (fixed).","type":"string"}},"$$ref":"#/components/schemas/MetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"description":"Details regarding the read only status of this instance","type":"object","properties":{"reason":{"description":"Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain).","enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"description":"True if this resource us read only and false otherwise.","type":"boolean"}},"$$ref":"#/components/schemas/ReadOnly"},"timestamp":{"description":"The last updated timestamp.","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/Metadata"},"name":{"type":"string"},"timeRekeyLimit":{"description":"Time rekey limit (minutes)","format":"int32","type":"integer"},"type":{"description":"Type of the SshServerSetting policy; this value is always SshServerSetting.","type":"string"},"version":{"description":"Version number of the response object.","type":"string"},"volumeRekeyLimit":{"description":"Volume rekey limit (KB)","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/SshServerSetting"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Policy"],"__originalOperationId":"getSshServerSetting","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshserversettings/{objectId}"}}