Jump to

• Request
• Response

Create a Tag Default

post

/20160918/tagDefaults

Creates a new tag default in the specified compartment for the specified tag definition. If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked. If the isRequired flag is set to "true", the value is set during resource creation. If the isRequired flag is set to "false", the value you enter is set during resource creation.

Request

Supported Media Types

• application/json

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Body ()

Request object for creating a new tag default.

Root Schema : CreateTagDefaultDetails

Type: object

Show Source

• compartmentId(required): string
  The OCID of the compartment. The tag default will be applied to all new resources created in this compartment.
• isRequired: boolean
  If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked. Note: If the isRequired flag is set to "true", the value is set during resource creation. If the isRequired flag is set to "false", the value you enter is set during resource creation. Example: false
• locks: array locks
  Maximum Number of Items: 1

  Locks associated with this resource.
• tagDefinitionId(required): string
  The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
• value(required): string
  The default value for the tag definition. This will be applied to all new resources created in the compartment.

{
    "required":[
        "compartmentId",
        "tagDefinitionId",
        "value"
    ],
    "properties":{
        "compartmentId":{
            "type":"string",
            "description":"The OCID of the compartment. The tag default will be applied to all new resources created in this compartment."
        },
        "tagDefinitionId":{
            "type":"string",
            "description":"The OCID of the tag definition. The tag default will always assign a default value for this tag definition."
        },
        "value":{
            "type":"string",
            "description":"The default value for the tag definition. This will be applied to all new resources created in the compartment."
        },
        "isRequired":{
            "type":"boolean",
            "description":"If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked. Note: If the isRequired flag is set to \"true\", the value is set during resource creation. If the isRequired flag is set to \"false\", the value you enter is set during resource creation. Example: false "
        },
        "locks":{
            "description":"Locks associated with this resource.",
            "type":"array",
            "maxItems":1,
            "items":{
                "$ref":"#/definitions/AddLockDetails"
            }
        }
    },
    "x-example":"{     \"compartmentId\" : \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",     \"tagDefinitionId\" : \"ocid1.tagdefinition.oc1..<var>&lt;unique_ID&gt;</var>\",     \"value\" : \"W123\",     \"isRequired\" : \"false\" } ",
    "type":"object"
}

Nested Schema : locks

Type: array

Maximum Number of Items: 1

Locks associated with this resource.

Show Source

• Array of: object AddLockDetails
  Request payload to add lock to the resource.

{
    "description":"Locks associated with this resource.",
    "type":"array",
    "maxItems":1,
    "items":{
        "$ref":"#/definitions/AddLockDetails"
    }
}

Nested Schema : AddLockDetails

Type: object

Request payload to add lock to the resource.

Show Source

• message: string
  A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
• relatedResourceId: string
  The OCID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
• type(required): string
  Allowed Values: [ "FULL", "DELETE" ]

  Lock type.

{
    "description":"Request payload to add lock to the resource.",
    "type":"object",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"Lock type.",
            "enum":[
                "FULL",
                "DELETE"
            ],
            "type":"string"
        },
        "relatedResourceId":{
            "description":"The OCID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.",
            "type":"string"
        },
        "message":{
            "description":"A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The tag default has been created.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : TagDefault

Type: object

Tag defaults let you specify a default tag (tagnamespace.tag="value") to apply to all resource types in a specified compartment. The tag default is applied at the time the resource is created. Resources that exist in the compartment before you create the tag default are not tagged. The TagDefault object specifies the tag and compartment details. Tag defaults are inherited by child compartments. This means that if you set a tag default on the root compartment for a tenancy, all resources that are created in the tenancy are tagged. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator.

Show Source

• compartmentId(required): string
  The OCID of the compartment. The tag default applies to all new resources that get created in the compartment. Resources that existed before the tag default was created are not tagged.
• id(required): string
  The OCID of the tag default.
• isRequired(required): boolean
  If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked. If the isRequired flag is set to "true", the value is set during resource creation. If the isRequired flag is set to "false", the value you enter is set during resource creation. Example: false
• lifecycleState: string
  Allowed Values: [ "ACTIVE" ]

  The tag default's current state. After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it.
• locks: array locks
  Locks associated with this resource.
• tagDefinitionId(required): string
  The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
• tagDefinitionName(required): string
  The name used in the tag definition. This field is informational in the context of the tag default.
• tagNamespaceId(required): string
  The OCID of the tag namespace that contains the tag definition.
• timeCreated(required): string(date-time)
  Date and time the TagDefault object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
• value(required): string
  The default value for the tag definition. This will be applied to all resources created in the compartment.

{
    "description":"Tag defaults let you specify a default tag (tagnamespace.tag=\"value\") to apply to all resource types in a specified compartment. The tag default is applied at the time the resource is created. Resources that exist in the compartment before you create the tag default are not tagged. The TagDefault object specifies the tag and compartment details. Tag defaults are inherited by child compartments. This means that if you set a tag default on the root compartment for a tenancy, all resources that are created in the tenancy are tagged. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator.",
    "x-obmcs-splat":{
        "resourceKind":"tag-default",
        "ocidEntityType":"tagdefault",
        "adLocality":"realm",
        "generateOcidVersion":"V2",
        "taggable":false,
        "activeLifecycleStates":[
            "active",
            "inactive"
        ],
        "deletedLifecycleStates":[
            "deleted"
        ],
        "getOperationId":"GetTagDefault",
        "listResourcesOperationId":"ListTagDefaults",
        "searchMetadata":{
            "resourceSchemaVersion":1,
            "resourceType":"TagDefault",
            "scope":"customer",
            "rvnFromHeader":true,
            "fieldNameMap":{
                "tagDefinitionName":"displayName"
            }
        }
    },
    "required":[
        "id",
        "compartmentId",
        "tagNamespaceId",
        "tagDefinitionId",
        "tagDefinitionName",
        "value",
        "timeCreated",
        "isRequired"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The OCID of the tag default."
        },
        "compartmentId":{
            "type":"string",
            "description":"The OCID of the compartment. The tag default applies to all new resources that get created in the compartment. Resources that existed before the tag default was created are not tagged."
        },
        "tagNamespaceId":{
            "type":"string",
            "description":"The OCID of the tag namespace that contains the tag definition."
        },
        "tagDefinitionId":{
            "type":"string",
            "description":"The OCID of the tag definition. The tag default will always assign a default value for this tag definition."
        },
        "tagDefinitionName":{
            "type":"string",
            "description":"The name used in the tag definition. This field is informational in the context of the tag default."
        },
        "value":{
            "type":"string",
            "description":"The default value for the tag definition. This will be applied to all resources created in the compartment."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time the TagDefault object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z "
        },
        "lifecycleState":{
            "type":"string",
            "enum":[
                "ACTIVE"
            ],
            "description":"The tag default's current state. After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it."
        },
        "isRequired":{
            "type":"boolean",
            "description":"If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked. If the isRequired flag is set to \"true\", the value is set during resource creation. If the isRequired flag is set to \"false\", the value you enter is set during resource creation. Example: false "
        },
        "locks":{
            "description":"Locks associated with this resource.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResourceLock"
            }
        }
    },
    "x-example":"{   \"id\" : \"ocid1.tagdefault.oc1..<var>&lt;unique_ID&gt;</var>\",   \"compartmentId\" : \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",   \"tagNamespaceId\" : \"ocid1.namespace.oc1..<var>&lt;unique_ID&gt;</var>\",   \"tagDefinitionId\" : \"ocid1.tagdefinition.oc1..<var>&lt;unique_ID&gt;</var>\",   \"tagDefinitionName\" : \"Finance\",   \"value\" : \"W123\",   \"timeCreated\" : \"2018-11-22T19:00:00.000Z\",   \"lifecycleState\" : \"ACTIVE\",   \"isRequired\" : \"true\" } ",
    "type":"object"
}

Nested Schema : locks

Type: array

Locks associated with this resource.

Show Source

• Array of: object ResourceLock
  Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.

{
    "description":"Locks associated with this resource.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ResourceLock"
    }
}

Nested Schema : ResourceLock

Type: object

Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.

Show Source

• message: string
  A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
• relatedResourceId: string
  The OCID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
• timeCreated: string(date-time)
  Indicates when the lock was created, in the format defined by RFC 3339.
• type(required): string
  Allowed Values: [ "FULL", "DELETE" ]

  Lock type.

{
    "description":"Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.",
    "type":"object",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"Lock type.",
            "enum":[
                "FULL",
                "DELETE"
            ],
            "type":"string"
        },
        "relatedResourceId":{
            "description":"The OCID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.",
            "type":"string"
        },
        "message":{
            "description":"A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.",
            "type":"string"
        },
        "timeCreated":{
            "format":"date-time",
            "type":"string",
            "description":"Indicates when the lock was created, in the format defined by RFC 3339."
        }
    }
}

Example Response (application-json)

{   "id" : "ocid1.tagdefault.oc1..aaaaaaaashexampleuniqueID",   "compartmentId" : "ocid1.compartment.oc1..aaaaaaaaexampleuniqueID",   "tagNamespaceId" : "ocid1.namespace.oc1..aaaaaaaasexampleuniqueID",   "tagDefinitionId" : "ocid1.tagdefinition.oc1..aaaaaaaash5exampleuniqueID",   "tagDefinitionName" : "Finance",   "value" : "W123",   "timeCreated" : "2018-11-22T19:00:00.000Z",   "lifecycleState" : "ACTIVE",   "isRequired" : "true" } 

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

409 Response

Conflict

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top